Skip to main content

BitCounter

tlbits::adapters

Struct BitCounter 

Source 
pub struct BitCounter<T> { /* private fields */ }
Expand description

Adapter for counting the number of bits read/written.

Implementations§

Source§

impl<T> BitCounter<T>

Source

pub const fn new(inner: T) -> Self

Source

pub const fn bit_count(&self) -> usize

Return total number of recorded bits

Source

pub fn into_inner(self) -> T

Trait Implementations§

Source§

impl<'de, R> BitReader<'de> for BitCounter<R>
where R: BitReader<'de>,

Source§

type Error = <R as BitReader<'de>>::Error

Source§

fn bits_left(&self) -> usize

Returns count of bits left to read more
Source§

fn read_bit(&mut self) -> Result<Option<bool>, Self::Error>

Reads only one bit.
Source§

fn read_bits_into( &mut self, dst: &mut BitSlice<u8, Msb0>, ) -> Result<usize, Self::Error>

Reads dst.len() bits into given bitslice. Might be optimized by the implementation.
Source§

fn read_bits( &mut self, n: usize, ) -> Result<Cow<'de, BitSlice<u8, Msb0>>, Self::Error>

Reads n bits and returns possibly borrowed BitSlice
Source§

fn skip(&mut self, n: usize) -> Result<usize, Self::Error>

Reads and discards n bits
Source§

impl<W> BitWriter for BitCounter<W>
where W: BitWriter,

Source§

type Error = <W as BitWriter>::Error

Source§

fn capacity_left(&self) -> usize

Returns remaining capacity in bits
Source§

fn write_bit(&mut self, bit: bool) -> Result<(), Self::Error>

Writes a single bit.
Source§

fn write_bitslice( &mut self, bits: &BitSlice<u8, Msb0>, ) -> Result<(), Self::Error>

Writes given bitslice.
Might be optimized by the implementation.
Source§

fn repeat_bit(&mut self, n: usize, bit: bool) -> Result<(), Self::Error>

Writes given bit exactly n times.
Might be optimized by the implementation.
Source§

impl<T: Clone> Clone for BitCounter<T>

Source§

fn clone(&self) -> BitCounter<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for BitCounter<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T> Deref for BitCounter<T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

§

impl<T> Freeze for BitCounter<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for BitCounter<T>
where T: RefUnwindSafe,

§

impl<T> Send for BitCounter<T>
where T: Send,

§

impl<T> Sync for BitCounter<T>
where T: Sync,

§

impl<T> Unpin for BitCounter<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for BitCounter<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for BitCounter<T>
where T: 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> BitPackWrapAsExt for T

Source§

fn wrap_as<As>(&self) -> AsWrap<&Self, As>
where As: BitPackAs<Self> + ?Sized,

Source§

impl<'de, T> BitReaderExt<'de> for T
where T: BitReader<'de> + ?Sized,

Source§

fn is_empty(&self) -> bool

Returns wheather the reader is empty
Source§

fn read_bytes_into( &mut self, dst: impl AsMut<[u8]>, ) -> Result<usize, Self::Error>

Reads dst.len() bytes into given byte slice
Source§

fn read_bytes_array<const N: usize>(&mut self) -> Result<[u8; N], Self::Error>

Read N bytes and return array
Source§

fn unpack<T>(&mut self, args: T::Args) -> Result<T, Self::Error>
where T: BitUnpack<'de>,

Unpack value witg args using its BitUnpack implementation
Source§

fn unpack_iter<'a, T>( &'a mut self, args: T::Args, ) -> impl Iterator<Item = Result<T, Self::Error>> + 'a
where T: BitUnpack<'de>, T::Args: Clone + 'a,

Return iterator that unpacks values with args using BitUnpack implementation
Source§

fn unpack_as<T, As>(&mut self, args: As::Args) -> Result<T, Self::Error>
where As: BitUnpackAs<'de, T> + ?Sized,

Unpack value with args using an adapter. Read more
Source§

fn unpack_iter_as<'a, T, As>( &'a mut self, args: As::Args, ) -> impl Iterator<Item = Result<T, Self::Error>> + 'a
where As: BitUnpackAs<'de, T> + ?Sized, As::Args: Clone + 'a,

Returns iterator that unpacks values with args using an adapter. Read more
Source§

fn as_mut(&mut self) -> &mut Self

Borrows reader, rather than consuming it.
Source§

fn map_err<F>(self, f: F) -> MapErr<Self, F>
where Self: Sized,

Map Error by given closure
Source§

fn tee<W>(self, writer: W) -> Tee<Self, W>
where Self: Sized, W: BitWriter,

Mirror all read data to given writer as well.
Source§

fn checkpoint(self) -> Checkpoint<Self>
where Self: Sized,

Source§

fn join<R>(self, next: R) -> Join<Self, R>
where Self: Sized, R: BitReader<'de>,

Source§

impl<T> BitWriterExt for T
where T: BitWriter + ?Sized,

Source§

fn with_repeat_bit( &mut self, n: usize, bit: bool, ) -> Result<&mut Self, Self::Error>

Same as .repeat_bit() but can be used for chaining
Source§

fn pack<T>(&mut self, value: T, args: T::Args) -> Result<&mut Self, Self::Error>
where T: BitPack,

Pack given value with args using its BitPack implementation
Source§

fn pack_many<T>( &mut self, values: impl IntoIterator<Item = T>, args: T::Args, ) -> Result<&mut Self, Self::Error>
where T: BitPack, T::Args: Clone,

Pack all values with args from given iterator using BitPack implementation of its item type.
Source§

fn pack_as<T, As>( &mut self, value: T, args: As::Args, ) -> Result<&mut Self, Self::Error>
where As: BitPackAs<T> + ?Sized,

Pack given value with args using an adapter. Read more
Source§

fn pack_many_as<T, As>( &mut self, values: impl IntoIterator<Item = T>, args: As::Args, ) -> Result<&mut Self, Self::Error>
where As: BitPackAs<T> + ?Sized, As::Args: Clone,

Pack all values from iterator with args using an adapter. Read more
Source§

fn as_mut(&mut self) -> &mut Self

Borrows writer, rather than consuming it.
Source§

fn map_err<F>(self, f: F) -> MapErr<Self, F>
where Self: Sized,

Map Error by given closure
Source§

fn counted(self) -> BitCounter<Self>
where Self: Sized,

Wrap this writer to count written bits by using .bit_count().
Source§

fn limit(self, n: usize) -> LimitWriter<Self>
where Self: Sized,

Sets given limit on this writer.
Returned wrapped writer will return an error when caller tries to write value which will exceed the total limit by using .pack() or any similar method.
Source§

fn tee<W>(self, writer: W) -> Tee<Self, W>
where Self: Sized, W: BitWriter,

Mirror all written data to given writer as well.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.