Trait frame_support::dispatch::fmt::Write

pub trait Write {
    pub fn write_str(&mut self, s: &str) -> Result<(), Error>;

    pub fn write_char(&mut self, c: char) -> Result<(), Error> { ... }
    pub fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error> { ... }
}

A trait for writing or formatting into Unicode-accepting buffers or streams.

This trait only accepts UTF-8–encoded data and is not flushable. If you only want to accept Unicode and you don’t need flushing, you should implement this trait; otherwise you should implement std::io::Write.

Required methods

pub fn write_str(&mut self, s: &str) -> Result<(), Error>

Writes a string slice into this writer, returning whether the write succeeded.

This method can only succeed if the entire string slice was successfully written, and this method will not return until all data has been written or an error occurs.

Errors

This function will return an instance of Error on error.

Examples

use std::fmt::{Error, Write};

fn writer<W: Write>(f: &mut W, s: &str) -> Result<(), Error> {
    f.write_str(s)
}

let mut buf = String::new();
writer(&mut buf, "hola").unwrap();
assert_eq!(&buf, "hola");

Loading content...

Provided methods

pub fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

A single char may be encoded as more than one byte. This method can only succeed if the entire byte sequence was successfully written, and this method will not return until all data has been written or an error occurs.

Errors

This function will return an instance of Error on error.

Examples

use std::fmt::{Error, Write};

fn writer<W: Write>(f: &mut W, c: char) -> Result<(), Error> {
    f.write_char(c)
}

let mut buf = String::new();
writer(&mut buf, 'a').unwrap();
writer(&mut buf, 'b').unwrap();
assert_eq!(&buf, "ab");

pub fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

This method should generally not be invoked manually, but rather through the write! macro itself.

Examples

use std::fmt::{Error, Write};

fn writer<W: Write>(f: &mut W, s: &str) -> Result<(), Error> {
    f.write_fmt(format_args!("{}", s))
}

let mut buf = String::new();
writer(&mut buf, "world").unwrap();
assert_eq!(&buf, "world");

Loading content...

Implementations on Foreign Types

impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, 

pub fn write_str(&mut self, s: &str) -> Result<(), Error>

pub fn write_char(&mut self, c: char) -> Result<(), Error>

pub fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

impl Write for String

pub fn write_str(&mut self, s: &str) -> Result<(), Error>

pub fn write_char(&mut self, c: char) -> Result<(), Error>

impl<A> Write for ArrayString<A> where
    A: Array<Item = u8> + Copy, 

Write appends written data to the end of the string.

pub fn write_char(&mut self, c: char) -> Result<(), Error>

pub fn write_str(&mut self, s: &str) -> Result<(), Error>

impl<'a, S, A> Write for Matcher<'a, S, A> where
    A: DFA<ID = S>,
    S: StateID, 

pub fn write_str(&mut self, s: &str) -> Result<(), Error>

impl<A> Write for ArrayString<A> where
    A: Array<Item = u8>, 

Write appends written data to the end of the string.

pub fn write_char(&mut self, c: char) -> Result<(), Error>

pub fn write_str(&mut self, s: &str) -> Result<(), Error>

Loading content...

Implementors

impl Write for Writer

pub fn write_str(&mut self, s: &str) -> Result<(), Error>

impl<'_> Write for Formatter<'_>

pub fn write_str(&mut self, s: &str) -> Result<(), Error>

pub fn write_char(&mut self, c: char) -> Result<(), Error>

pub fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Loading content...