Struct `EncoderStringWriter`

struct EncoderStringWriter<'e, E: Engine, S: StrConsumer> { ... }

A Write implementation that base64-encodes data using the provided config and accumulates the resulting base64 utf8 &str in a [StrConsumer] implementation (typically String), which is then exposed via into_inner().

Examples

Buffer base64 in a new String:

use std::io::Write;
use base64::engine::general_purpose;

let mut enc = base64::write::EncoderStringWriter::new(&general_purpose::STANDARD);

enc.write_all(b"asdf").unwrap();

// get the resulting String
let b64_string = enc.into_inner();

assert_eq!("YXNkZg==", &b64_string);

Or, append to an existing String, which implements StrConsumer:

use std::io::Write;
use base64::engine::general_purpose;

let mut buf = String::from("base64: ");

let mut enc = base64::write::EncoderStringWriter::from_consumer(
    &mut buf,
    &general_purpose::STANDARD);

enc.write_all(b"asdf").unwrap();

// release the &mut reference on buf
let _ = enc.into_inner();

assert_eq!("base64: YXNkZg==", &buf);

Performance

Because it has to validate that the base64 is UTF-8, it is about 80% as fast as writing plain bytes to a io::Write.

Implementations

`impl<'e, E: Engine> EncoderStringWriter<'e, E, String>`

fn new(engine: &'e E) -> Self: Create a EncoderStringWriter that will encode into a new String with the provided config.

`impl<'e, E: Engine, S: StrConsumer> EncoderStringWriter<'e, E, S>`

fn from_consumer(str_consumer: S, engine: &'e E) -> Self

Create a EncoderStringWriter that will append to the provided StrConsumer.

fn into_inner(self: Self) -> S

Encode all remaining buffered data, including any trailing incomplete input triples and associated padding.

Returns the base64-encoded form of the accumulated written data.

`impl<'e, E, S> Freeze for EncoderStringWriter<'e, E, S>`

`impl<'e, E, S> RefUnwindSafe for EncoderStringWriter<'e, E, S>`

`impl<'e, E, S> Send for EncoderStringWriter<'e, E, S>`

`impl<'e, E, S> Sync for EncoderStringWriter<'e, E, S>`

`impl<'e, E, S> Unpin for EncoderStringWriter<'e, E, S>`

`impl<'e, E, S> UnsafeUnpin for EncoderStringWriter<'e, E, S>`

`impl<'e, E, S> UnwindSafe for EncoderStringWriter<'e, E, S>`

`impl<'e, E: Engine, S: StrConsumer> Write for EncoderStringWriter<'e, E, S>`

fn write(self: &mut Self, buf: &[u8]) -> Result<usize>
fn flush(self: &mut Self) -> Result<()>

`impl<T> Any for EncoderStringWriter<'e, E, S>`

fn type_id(self: &Self) -> TypeId

`impl<T> Borrow for EncoderStringWriter<'e, E, S>`

fn borrow(self: &Self) -> &T

`impl<T> BorrowMut for EncoderStringWriter<'e, E, S>`

fn borrow_mut(self: &mut Self) -> &mut T

`impl<T> From for EncoderStringWriter<'e, E, S>`

fn from(t: T) -> T: Returns the argument unchanged.

`impl<T, U> Into for EncoderStringWriter<'e, E, S>`

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

`impl<T, U> TryFrom for EncoderStringWriter<'e, E, S>`

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

`impl<T, U> TryInto for EncoderStringWriter<'e, E, S>`

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>