alloc::format - Rust
Description: API documentation for the Rust `format` macro in crate `alloc`.
Keywords: rust, rustlang, rust-lang, format

# Macro alloc::format 1.0.0[−][src]

    macro_rules! format {
        ($($arg:tt)*) => { ... };
    }

Creates a `String` using interpolation of runtime expressions.

The first argument `format!` receives is a format string. This must be a string literal. The power of the formatting string is in the `{}`s contained.

Additional parameters passed to `format!` replace the `{}`s within the formatting string in the order given unless named or positional parameters are used, see `std::fmt` for more information.

A common use for `format!` is concatenation and interpolation of strings. The same convention is used with `print!` and `write!` macros, depending on the intended destination of the string.

# Panics

`format!` panics if a formatting trait implementation returns an error. This indicates an incorrect implementation since `fmt::Write for String` never returns an error itself.

# Examples

    format!("test");
    format!("hello {}", "world!");
    format!("x = {}, y = {y}", 10, y = 30);

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