collections::fmt::format - Rust
Description: API documentation for the Rust `format` fn in crate `collections`.
Keywords: rust, rustlang, rust-lang, format

# Function collections::fmt::format 1.0.0 [−] [src]

    pub fn format(args: Arguments) -> String

The format function takes a precompiled format string and a list of arguments, to return the resulting formatted string.

# Arguments

- args - a structure of arguments generated via the `format_args!` macro.

# Examples

Basic usage:

    use std::fmt;

    let s = fmt::format(format_args!("Hello, {}!", "world"));
    assert_eq!(s, "Hello, world!");Run

Please note that using `format!` might be preferrable. Example:

    let s = format!("Hello, {}!", "world");
    assert_eq!(s, "Hello, world!");Run

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand 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`)