Struct base64::write::EncoderStringWriter
source · pub struct EncoderStringWriter<'e, E: Engine, S: StrConsumer> {
encoder: EncoderWriter<'e, E, Utf8SingleCodeUnitWriter<S>>,
}
Expand description
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
.
Fields§
§encoder: EncoderWriter<'e, E, Utf8SingleCodeUnitWriter<S>>
Implementations§
source§impl<'e, E: Engine, S: StrConsumer> EncoderStringWriter<'e, E, S>
impl<'e, E: Engine, S: StrConsumer> EncoderStringWriter<'e, E, S>
sourcepub fn from_consumer(str_consumer: S, engine: &'e E) -> Self
pub fn from_consumer(str_consumer: S, engine: &'e E) -> Self
Create a EncoderStringWriter that will append to the provided StrConsumer
.
sourcepub fn into_inner(self) -> S
pub fn into_inner(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.
Trait Implementations§
source§impl<'e, E: Engine, S: StrConsumer> Write for EncoderStringWriter<'e, E, S>
impl<'e, E: Engine, S: StrConsumer> Write for EncoderStringWriter<'e, E, S>
source§fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Writes a buffer into this writer, returning how many bytes were written. Read more
source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flushes this output stream, ensuring that all intermediately buffered
contents reach their destination. Read more
source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this writer. Read more
source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
🔬This is a nightly-only experimental API. (
write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
Auto Trait Implementations§
impl<'e, E, S> Freeze for EncoderStringWriter<'e, E, S>where
S: Freeze,
impl<'e, E, S> RefUnwindSafe for EncoderStringWriter<'e, E, S>where
E: RefUnwindSafe,
S: RefUnwindSafe,
impl<'e, E, S> Send for EncoderStringWriter<'e, E, S>where
S: Send,
impl<'e, E, S> Sync for EncoderStringWriter<'e, E, S>where
S: Sync,
impl<'e, E, S> Unpin for EncoderStringWriter<'e, E, S>where
S: Unpin,
impl<'e, E, S> UnwindSafe for EncoderStringWriter<'e, E, S>where
E: RefUnwindSafe,
S: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more