Skip to main content

DecodeWriter

Struct DecodeWriter 

Source
pub struct DecodeWriter<W: Write, const N: usize> { /* private fields */ }
Expand description

A buffered writer that decodes encoded bytes before writing them to an inner writer.

This writer buffers encoded characters, decodes them using the specified Encoding<N>, and writes the decoded output to the wrapped writer. It implements io::Write, allowing transparent decoding of data streams.

Only complete encoding groups are decoded during normal writes. Incomplete groups are kept in the buffer until flush is called, at which point they are decoded (potentially with padding handling for base64/base32).

§Examples

use std::io::Write;

use omp_core::encoding::{DecodeWriter, base64};

let mut output = Vec::new();
let mut writer = base64::decode_writer(&mut output);
writer.write_all(b"SGVsbG8sIFdvcmxkIQ==").unwrap();
writer.flush().unwrap();
drop(writer);
assert_eq!(output, b"Hello, World!");

Implementations§

Source§

impl<W: Write, const N: usize> DecodeWriter<W, N>

Source

pub const fn new(inner: W, enc: Encoding<N>) -> Self

Creates a new decoding writer that wraps the given writer.

Source

pub fn into_inner(self) -> Result<W>

Consumes this writer, flushing any buffered data and returning the inner writer.

§Errors

Returns an error if flushing or decoding fails.

Trait Implementations§

Source§

impl<W: Write, const N: usize> Drop for DecodeWriter<W, N>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl<W: Write, const N: usize> Write for DecodeWriter<W, N>

Source§

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<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · Source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers. Read more
Source§

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 · Source§

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>

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · Source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations§

§

impl<W, const N: usize> Freeze for DecodeWriter<W, N>
where W: Freeze,

§

impl<W, const N: usize> RefUnwindSafe for DecodeWriter<W, N>
where W: RefUnwindSafe,

§

impl<W, const N: usize> Send for DecodeWriter<W, N>
where W: Send,

§

impl<W, const N: usize> Sync for DecodeWriter<W, N>
where W: Sync,

§

impl<W, const N: usize> Unpin for DecodeWriter<W, N>
where W: Unpin,

§

impl<W, const N: usize> UnsafeUnpin for DecodeWriter<W, N>
where W: UnsafeUnpin,

§

impl<W, const N: usize> UnwindSafe for DecodeWriter<W, N>
where W: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.