Trait freya::prelude::Default

1.0.0 · source ·

pub trait Default: Sized {
    // Required method
    fn default() -> Self;
}

Expand description

A trait for giving a type a useful default value.

Sometimes, you want to fall back to some kind of default value, and don’t particularly care what it is. This comes up often with structs that define a set of options:

struct SomeOptions {
    foo: i32,
    bar: f32,
}

How can we define some default values? You can use Default:

#[derive(Default)]
struct SomeOptions {
    foo: i32,
    bar: f32,
}

fn main() {
    let options: SomeOptions = Default::default();
}

Now, you get all of the default values. Rust implements Default for various primitives types.

If you want to override a particular option, but still retain the other defaults:

fn main() {
    let options = SomeOptions { foo: 42, ..Default::default() };
}

Derivable

This trait can be used with #[derive] if all of the type’s fields implement Default. When derived, it will use the default value for each field’s type.

`enum`s

When using #[derive(Default)] on an enum, you need to choose which unit variant will be default. You do this by placing the #[default] attribute on the variant.

#[derive(Default)]
enum Kind {
    #[default]
    A,
    B,
    C,
}

You cannot use the #[default] attribute on non-unit or non-exhaustive variants.

How can I implement `Default`?

Provide an implementation for the default() method that returns the value of your type that should be the default:

enum Kind {
    A,
    B,
    C,
}

impl Default for Kind {
    fn default() -> Self { Kind::A }
}

Examples

#[derive(Default)]
struct SomeOptions {
    foo: i32,
    bar: f32,
}

Required Methods§

source

fn default() -> Self

Returns the “default value” for a type.

Default values are often some kind of initial value, identity value, or anything else that may make sense as a default.

Examples

Using built-in default values:

let i: i8 = Default::default();
let (x, y): (Option<String>, f64) = Default::default();
let (a, b, (c, d)): (i32, u32, (bool, bool)) = Default::default();

Making your own:

enum Kind {
    A,
    B,
    C,
}

impl Default for Kind {
    fn default() -> Self { Kind::A }
}

Trait freya::prelude::Default

Required Methods§

fn default() -> Self

Implementors§

impl Default for &str

impl Default for &CStr

impl Default for &OsStr

impl Default for &mut str

impl Default for Code

impl Default for Key

impl Default for AccordionStatus

impl Default for Alignment

impl Default for ButtonStatus

impl Default for DirectionMode

impl Default for DropdownItemStatus

impl Default for DropdownStatus

impl Default for EditableMode

impl Default for InputMode

impl Default for InputStatus

impl Default for OrderDirection

impl Default for Position

impl Default for ScrollThumbState

impl Default for freya::prelude::Size

impl Default for SliderStatus

impl Default for SwitchStatus

impl Default for IpNet

impl Default for Value

impl Default for PathArguments

impl Default for bool

impl Default for char

impl Default for f32

impl Default for f64

impl Default for i8

impl Default for i16

impl Default for i32

impl Default for i64

impl Default for i128

impl Default for isize

impl Default for u8

impl Default for u16

impl Default for u32

impl Default for u64

impl Default for u128

impl Default for ()

impl Default for usize

impl Default for freya_core::accessibility::accessibility_state::AccessibilityState

impl Default for ElementsState

impl Default for Layers

impl Default for Viewports

impl Default for PluginsManager

impl Default for FreyaDOM

impl Default for NodeReferenceLayout

impl Default for Modifiers

impl Default for PerformanceOverlayPlugin

impl Default for Global

impl Default for alloc::boxed::Box<str, Global>

impl Default for alloc::boxed::Box<CStr, Global>

impl Default for alloc::boxed::Box<OsStr, Global>

impl Default for CString

impl Default for String

impl Default for Error

impl Default for SipHasher

impl Default for PhantomPinned

impl Default for RangeFull

impl Default for AtomicBool

impl Default for AtomicI8

impl Default for AtomicI16

impl Default for AtomicI32

impl Default for AtomicI64

impl Default for AtomicIsize

impl Default for AtomicU8

impl Default for AtomicU16

impl Default for AtomicU32

impl Default for AtomicU64

impl Default for AtomicUsize

impl Default for Duration

impl Default for proc_macro::TokenStream

impl Default for System

impl Default for DefaultHasher

impl Default for std::collections::hash::map::RandomState