# 1.2.0[−][src]Struct std::fmt::DebugStruct

    #[must_use = "must eventually call `finish()` on Debug builders"]
    pub struct DebugStruct<'a, 'b> where
        'b: 'a,
        'b: 'a,
        'b: 'b,  { /* fields omitted */ }

A struct to help with `fmt::Debug` implementations.

This is useful when you wish to output a formatted struct as a part of your `Debug::fmt` implementation.

This can be constructed by the `Formatter::debug_struct` method.

# Examples

    use std::fmt;

    struct Foo {
        bar: i32,
        baz: String,
    }

    impl fmt::Debug for Foo {
        fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
            fmt.debug_struct("Foo")
               .field("bar", &self.bar)
               .field("baz", &self.baz)
               .finish()
        }
    }

    assert_eq!(
        format!("{:?}", Foo { bar: 10, baz: "Hello World".to_string() }),
        "Foo { bar: 10, baz: \"Hello World\" }",
    );Run

## Methods

### `impl<'a, 'b> DebugStruct<'a, 'b> where
'b: 'a,` [src]

#### `pub fn field(
&mut self,
name: &str,
value: &dyn Debug
) -> &mut DebugStruct<'a, 'b>`[src]

Adds a new field to the generated struct output.

# Examples

    use std::fmt;

    struct Bar {
        bar: i32,
        another: String,
    }

    impl fmt::Debug for Bar {
        fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
            fmt.debug_struct("Bar")
               .field("bar", &self.bar) // We add `bar` field.
               .field("another", &self.another) // We add `another` field.
               // We even add a field which doesn't exist (because why not?).
               .field("not_existing_field", &1)
               .finish() // We're good to go!
        }
    }

    assert_eq!(
        format!("{:?}", Bar { bar: 10, another: "Hello World".to_string() }),
        "Bar { bar: 10, another: \"Hello World\", not_existing_field: 1 }",
    );Run

#### `pub fn finish(&mut self) -> Result<(), Error>`[src]

Finishes output and returns any error encountered.

# Examples

    use std::fmt;

    struct Bar {
        bar: i32,
        baz: String,
    }

    impl fmt::Debug for Bar {
        fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
            fmt.debug_struct("Bar")
               .field("bar", &self.bar)
               .field("baz", &self.baz)
               .finish() // You need to call it to "finish" the
                         // struct formatting.
        }
    }

    assert_eq!(
        format!("{:?}", Bar { bar: 10, baz: "Hello World".to_string() }),
        "Bar { bar: 10, baz: \"Hello World\" }",
    );Run

## Auto Trait Implementations

### `impl<'a, 'b> !UnwindSafe for DebugStruct<'a, 'b>`

### `impl<'a, 'b> !RefUnwindSafe for DebugStruct<'a, 'b>`

### `impl<'a, 'b> Unpin for DebugStruct<'a, 'b> where
'b: 'a,`

### `impl<'a, 'b> !Sync for DebugStruct<'a, 'b>`

### `impl<'a, 'b> !Send for DebugStruct<'a, 'b>`

## Blanket Implementations

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)