Trait std::default::Default

pub trait Default {
    fn default() -> Self;
}

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.

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() -> Kind { Kind::A }
}

Examples

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

Required Methods

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() -> Kind { Kind::A }
}

Implementors

impl Default for bool

fn default() -> bool

Returns the default value of false

impl Default for char

fn default() -> char

Returns the default value of \x00

impl Default for f32

fn default() -> f32

Returns the default value of 0.0

impl Default for f64

fn default() -> f64

Returns the default value of 0.0

impl Default for i128

fn default() -> i128

Returns the default value of 0

impl Default for i16

fn default() -> i16

Returns the default value of 0

impl Default for i32

fn default() -> i32

Returns the default value of 0

impl Default for i64

fn default() -> i64

Returns the default value of 0

impl Default for i8

fn default() -> i8

Returns the default value of 0

impl Default for isize

fn default() -> isize

Returns the default value of 0

impl Default for u128

fn default() -> u128

Returns the default value of 0

impl Default for u16

fn default() -> u16

Returns the default value of 0

impl Default for u32

fn default() -> u32

Returns the default value of 0

impl Default for u64

fn default() -> u64

Returns the default value of 0

impl Default for u8

fn default() -> u8

Returns the default value of 0

impl Default for ()

fn default()

Returns the default value of ()

impl Default for usize

fn default() -> usize

Returns the default value of 0

impl Default for Global

fn default() -> Global

impl Default for Box<str>

Important traits for Box<I>

impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>

fn default() -> Box<str>

impl Default for Box<CStr>

Important traits for Box<I>

impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>

fn default() -> Box<CStr>

impl Default for Box<OsStr>

Important traits for Box<I>

impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>

fn default() -> Box<OsStr>

impl Default for DefaultHasher

fn default() -> DefaultHasher

Creates a new DefaultHasher using new. See its documentation for more.

impl Default for RandomState

fn default() -> RandomState

Constructs a new RandomState.

impl Default for CString

fn default() -> CString

Creates an empty CString.

impl Default for OsString

fn default() -> OsString

Constructs an empty OsString.

impl Default for Error

fn default() -> Error

impl Default for SipHasher

fn default() -> SipHasher

impl Default for PathBuf

fn default() -> Self

impl Default for String

fn default() -> String

Creates an empty String.

impl Default for AtomicBool

fn default() -> AtomicBool

Creates an AtomicBool initialized to false.

impl Default for AtomicI16

fn default() -> AtomicI16

impl Default for AtomicI32

fn default() -> AtomicI32

impl Default for AtomicI64

fn default() -> AtomicI64

impl Default for AtomicI8

fn default() -> AtomicI8

impl Default for AtomicIsize

fn default() -> AtomicIsize

impl Default for AtomicU16

fn default() -> AtomicU16

impl Default for AtomicU32

fn default() -> AtomicU32

impl Default for AtomicU64

fn default() -> AtomicU64

impl Default for AtomicU8

fn default() -> AtomicU8

impl Default for AtomicUsize

fn default() -> AtomicUsize

impl Default for Condvar

fn default() -> Condvar

Creates a Condvar which is ready to be waited on and notified.

impl Default for Duration

fn default() -> Duration

impl<'a> Default for &'a str

fn default() -> &'a str

Creates an empty str

impl<'a> Default for &'a CStr

fn default() -> &'a CStr

impl<'a> Default for &'a OsStr

fn default() -> &'a OsStr

Creates an empty OsStr.

impl<'a> Default for &'a mut str

fn default() -> &'a mut str

Creates an empty mutable str

impl<'a, B> Default for Cow<'a, B> where     B: ToOwned + ?Sized,     <B as ToOwned>::Owned: Default,

fn default() -> Cow<'a, B>

Creates an owned Cow<'a, B> with the default value for the contained owned value.

impl<'a, T> Default for &'a [T]

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

fn default() -> &'a [T]

Creates an empty slice.

impl<'a, T> Default for &'a mut [T]

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

fn default() -> &'a mut [T]

Creates a mutable empty slice.

impl<A> Default for (A,) where     A: Default,

fn default() -> (A,)

impl<A, B> Default for (A, B) where     A: Default,     B: Default,

fn default() -> (A, B)

impl<A, B, C> Default for (A, B, C) where     A: Default,     B: Default,     C: Default,

fn default() -> (A, B, C)

impl<A, B, C, D> Default for (A, B, C, D) where     A: Default,     B: Default,     C: Default,     D: Default,

fn default() -> (A, B, C, D)

impl<A, B, C, D, E> Default for (A, B, C, D, E) where     A: Default,     B: Default,     C: Default,     D: Default,     E: Default,

fn default() -> (A, B, C, D, E)

impl<A, B, C, D, E, F> Default for (A, B, C, D, E, F) where     A: Default,     B: Default,     C: Default,     D: Default,     E: Default,     F: Default,

fn default() -> (A, B, C, D, E, F)

impl<A, B, C, D, E, F, G> Default for (A, B, C, D, E, F, G) where     A: Default,     B: Default,     C: Default,     D: Default,     E: Default,     F: Default,     G: Default,

fn default() -> (A, B, C, D, E, F, G)

impl<A, B, C, D, E, F, G, H> Default for (A, B, C, D, E, F, G, H) where     A: Default,     B: Default,     C: Default,     D: Default,     E: Default,     F: Default,     G: Default,     H: Default,

fn default() -> (A, B, C, D, E, F, G, H)

impl<A, B, C, D, E, F, G, H, I> Default for (A, B, C, D, E, F, G, H, I) where     A: Default,     B: Default,     C: Default,     D: Default,     E: Default,     F: Default,     G: Default,     H: Default,     I: Default,

fn default() -> (A, B, C, D, E, F, G, H, I)

impl<A, B, C, D, E, F, G, H, I, J> Default for (A, B, C, D, E, F, G, H, I, J) where     A: Default,     B: Default,     C: Default,     D: Default,     E: Default,     F: Default,     G: Default,     H: Default,     I: Default,     J: Default,

fn default() -> (A, B, C, D, E, F, G, H, I, J)

impl<A, B, C, D, E, F, G, H, I, J, K> Default for (A, B, C, D, E, F, G, H, I, J, K) where     A: Default,     B: Default,     C: Default,     D: Default,     E: Default,     F: Default,     G: Default,     H: Default,     I: Default,     J: Default,     K: Default,

fn default() -> (A, B, C, D, E, F, G, H, I, J, K)

impl<A, B, C, D, E, F, G, H, I, J, K, L> Default for (A, B, C, D, E, F, G, H, I, J, K, L) where     A: Default,     B: Default,     C: Default,     D: Default,     E: Default,     F: Default,     G: Default,     H: Default,     I: Default,     J: Default,     K: Default,     L: Default,

fn default() -> (A, B, C, D, E, F, G, H, I, J, K, L)

impl<H> Default for BuildHasherDefault<H>

fn default() -> BuildHasherDefault<H>

impl<K, V> Default for BTreeMap<K, V> where     K: Ord,

fn default() -> BTreeMap<K, V>

Creates an empty BTreeMap<K, V>.

impl<K, V, S> Default for HashMap<K, V, S> where     K: Eq + Hash,     S: BuildHasher + Default,

fn default() -> HashMap<K, V, S>

Creates an empty HashMap<K, V, S>, with the Default value for the hasher.

impl<T> Default for Option<T>

fn default() -> Option<T>

Returns None.

impl<T> Default for [T; 0]

fn default() -> [T; 0]

impl<T> Default for [T; 1] where     T: Default,

fn default() -> [T; 1]

impl<T> Default for [T; 2] where     T: Default,

fn default() -> [T; 2]

impl<T> Default for [T; 3] where     T: Default,

fn default() -> [T; 3]

impl<T> Default for [T; 4] where     T: Default,

fn default() -> [T; 4]

impl<T> Default for [T; 5] where     T: Default,

fn default() -> [T; 5]

impl<T> Default for [T; 6] where     T: Default,

fn default() -> [T; 6]

impl<T> Default for [T; 7] where     T: Default,

fn default() -> [T; 7]

impl<T> Default for [T; 8] where     T: Default,

fn default() -> [T; 8]

impl<T> Default for [T; 9] where     T: Default,

fn default() -> [T; 9]

impl<T> Default for [T; 10] where     T: Default,

fn default() -> [T; 10]

impl<T> Default for [T; 11] where     T: Default,

fn default() -> [T; 11]

impl<T> Default for [T; 12] where     T: Default,

fn default() -> [T; 12]

impl<T> Default for [T; 13] where     T: Default,

fn default() -> [T; 13]

impl<T> Default for [T; 14] where     T: Default,

fn default() -> [T; 14]

impl<T> Default for [T; 15] where     T: Default,

fn default() -> [T; 15]

impl<T> Default for [T; 16] where     T: Default,

fn default() -> [T; 16]

impl<T> Default for [T; 17] where     T: Default,

fn default() -> [T; 17]

impl<T> Default for [T; 18] where     T: Default,

fn default() -> [T; 18]

impl<T> Default for [T; 19] where     T: Default,

fn default() -> [T; 19]

impl<T> Default for [T; 20] where     T: Default,

fn default() -> [T; 20]

impl<T> Default for [T; 21] where     T: Default,

fn default() -> [T; 21]

impl<T> Default for [T; 22] where     T: Default,

fn default() -> [T; 22]

impl<T> Default for [T; 23] where     T: Default,

fn default() -> [T; 23]

impl<T> Default for [T; 24] where     T: Default,

fn default() -> [T; 24]

impl<T> Default for [T; 25] where     T: Default,

fn default() -> [T; 25]

impl<T> Default for [T; 26] where     T: Default,

fn default() -> [T; 26]

impl<T> Default for [T; 27] where     T: Default,

fn default() -> [T; 27]

impl<T> Default for [T; 28] where     T: Default,

fn default() -> [T; 28]

impl<T> Default for [T; 29] where     T: Default,

fn default() -> [T; 29]

impl<T> Default for [T; 30] where     T: Default,

fn default() -> [T; 30]

impl<T> Default for [T; 31] where     T: Default,

fn default() -> [T; 31]

impl<T> Default for [T; 32] where     T: Default,

fn default() -> [T; 32]

impl<T> Default for Box<[T]>

Important traits for Box<I>

impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>

fn default() -> Box<[T]>

impl<T> Default for Box<T> where     T: Default,

Important traits for Box<I>

impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>

fn default() -> Box<T>

Creates a Box<T>, with the Default value for T.

impl<T> Default for Cell<T> where     T: Default,

fn default() -> Cell<T>

Creates a Cell<T>, with the Default value for T.

impl<T> Default for RefCell<T> where     T: Default,

fn default() -> RefCell<T>

Creates a RefCell<T>, with the Default value for T.

impl<T> Default for UnsafeCell<T> where     T: Default,

fn default() -> UnsafeCell<T>

Creates an UnsafeCell, with the Default value for T.

impl<T> Default for Reverse<T> where     T: Default,

fn default() -> Reverse<T>

impl<T> Default for BinaryHeap<T> where     T: Ord,

fn default() -> BinaryHeap<T>

Creates an empty BinaryHeap<T>.

impl<T> Default for BTreeSet<T> where     T: Ord,

fn default() -> BTreeSet<T>

Makes an empty BTreeSet<T> with a reasonable choice of B.

impl<T> Default for LinkedList<T>

fn default() -> LinkedList<T>

Creates an empty LinkedList<T>.

impl<T> Default for VecDeque<T>

fn default() -> VecDeque<T>

Creates an empty VecDeque<T>.

impl<T> Default for Empty<T>

Important traits for Empty<T>

impl<T> Iterator for Empty<T> type Item = T;

fn default() -> Empty<T>

impl<T> Default for PhantomData<T> where     T: ?Sized,

fn default() -> PhantomData<T>

impl<T> Default for ManuallyDrop<T> where     T: Default + ?Sized,

fn default() -> ManuallyDrop<T>

impl<T> Default for Wrapping<T> where     T: Default,

fn default() -> Wrapping<T>

impl<T> Default for Rc<T> where     T: Default,

fn default() -> Rc<T>

Creates a new Rc<T>, with the Default value for T.

Examples

use std::rc::Rc;

let x: Rc<i32> = Default::default();
assert_eq!(*x, 0);

impl<T> Default for std::rc::Weak<T>

fn default() -> Weak<T>

Constructs a new Weak<T>, allocating memory for T without initializing it. Calling [upgrade][Weak::upgrade] on the return value always gives None.

Examples

use std::rc::Weak;

let empty: Weak<i64> = Default::default();
assert!(empty.upgrade().is_none());

impl<T> Default for AtomicPtr<T>

fn default() -> AtomicPtr<T>

Creates a null AtomicPtr<T>.

impl<T> Default for Arc<T> where     T: Default,

fn default() -> Arc<T>

Creates a new Arc<T>, with the Default value for T.

Examples

use std::sync::Arc;

let x: Arc<i32> = Default::default();
assert_eq!(*x, 0);

impl<T> Default for std::sync::Weak<T>

fn default() -> Weak<T>

Constructs a new Weak<T>, without allocating memory. Calling [upgrade][Weak::upgrade] on the return value always gives None.

Examples

use std::sync::Weak;

let empty: Weak<i64> = Default::default();
assert!(empty.upgrade().is_none());

impl<T> Default for Vec<T>

Important traits for Vec<u8>

impl Write for Vec<u8>

fn default() -> Vec<T>

Creates an empty Vec<T>.

impl<T, S> Default for HashSet<T, S> where     T: Eq + Hash,     S: BuildHasher + Default,

fn default() -> HashSet<T, S>

Creates an empty HashSet<T, S> with the Default value for the hasher.

impl<T: Default> Default for RwLock<T>

fn default() -> RwLock<T>

Creates a new RwLock<T>, with the Default value for T.

impl<T: ?Sized + Default> Default for Mutex<T>

fn default() -> Mutex<T>

Creates a Mutex<T>, with the Default value for T.