alloc::fmt::DebugSet - Rust
Description: API documentation for the Rust `DebugSet` struct in crate `alloc`.
Keywords: rust, rustlang, rust-lang, DebugSet

# Struct alloc::fmt::DebugSet 1.2.0[−][src]

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

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

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

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

# Examples

    use std::fmt;

    struct Foo(Vec<i32>);

    impl fmt::Debug for Foo {
        fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
            fmt.debug_set().entries(self.0.iter()).finish()
        }
    }

    // prints "{10, 11}"
    println!("{:?}", Foo(vec![10, 11]));

## Methods

###

`impl<'a, 'b> DebugSet<'a, 'b> where 'b: 'a,`

[src]

####

`pub fn entry(&mut self, entry: &Debug) -> &mut DebugSet<'a, 'b>`

[src]

Adds a new entry to the set output.

####

`pub fn entries<D, I>(&mut self, entries: I) -> &mut DebugSet<'a, 'b> where D: Debug, I: IntoIterator<Item = D>,`

[src]

Adds the contents of an iterator of entries to the set output.

####

`pub fn finish(&mut self) -> Result<(), Error>`

[src]

Finishes output and returns any error encountered.

## Auto Trait Implementations

###

`impl<'a, 'b> !Send for DebugSet<'a, 'b>`

###

`impl<'a, 'b> !Sync for DebugSet<'a, 'b>`

# 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`)