Trait NixRead

pub trait NixRead: Send {
    type Error: Error + Send;

    // Required methods
    fn version(&self) -> ProtocolVersion;
    fn try_read_number(
        &mut self,
    ) -> impl Future<Output = Result<Option<u64>, Self::Error>> + Send + '_;
    fn try_read_bytes_limited(
        &mut self,
        limit: RangeInclusive<usize>,
    ) -> impl Future<Output = Result<Option<Bytes>, Self::Error>> + Send + '_;

    // Provided methods
    fn try_read_bytes(
        &mut self,
    ) -> impl Future<Output = Result<Option<Bytes>, Self::Error>> + Send + '_ { ... }
    fn read_number(
        &mut self,
    ) -> impl Future<Output = Result<u64, Self::Error>> + Send + '_ { ... }
    fn read_bytes_limited(
        &mut self,
        limit: RangeInclusive<usize>,
    ) -> impl Future<Output = Result<Bytes, Self::Error>> + Send + '_ { ... }
    fn read_bytes(
        &mut self,
    ) -> impl Future<Output = Result<Bytes, Self::Error>> + Send + '_ { ... }
    fn read_value<V: NixDeserialize>(
        &mut self,
    ) -> impl Future<Output = Result<V, Self::Error>> + Send + '_ { ... }
    fn try_read_value<V: NixDeserialize>(
        &mut self,
    ) -> impl Future<Output = Result<Option<V>, Self::Error>> + Send + '_ { ... }
}

A reader of data from the Nix daemon protocol. Basically there are two basic types in the Nix daemon protocol u64 and a bytes buffer. Everything else is more or less built on top of these two types.

Required Associated Types

type Error: Error + Send

Required Methods

fn version(&self) -> ProtocolVersion

Some types are serialized differently depending on the version of the protocol and so this can be used for implementing that.

fn try_read_number( &mut self, ) -> impl Future<Output = Result<Option<u64>, Self::Error>> + Send + '_

Read a single u64 from the protocol. This returns an Option to support graceful shutdown.

fn try_read_bytes_limited( &mut self, limit: RangeInclusive<usize>, ) -> impl Future<Output = Result<Option<Bytes>, Self::Error>> + Send + '_

Read bytes from the protocol. A size limit on the returned bytes has to be specified. This returns an Option to support graceful shutdown.

Provided Methods

fn try_read_bytes( &mut self, ) -> impl Future<Output = Result<Option<Bytes>, Self::Error>> + Send + '_

Read bytes from the protocol without a limit. The default implementation just calls try_read_bytes_limited with a limit of 0..=usize::MAX but other implementations are free to have a reader wide limit. This returns an Option to support graceful shutdown.

fn read_number( &mut self, ) -> impl Future<Output = Result<u64, Self::Error>> + Send + '_

Read a single u64 from the protocol. This will return an error if the number could not be read.

fn read_bytes_limited( &mut self, limit: RangeInclusive<usize>, ) -> impl Future<Output = Result<Bytes, Self::Error>> + Send + '_

Read bytes from the protocol. A size limit on the returned bytes has to be specified. This will return an error if the number could not be read.

fn read_bytes( &mut self, ) -> impl Future<Output = Result<Bytes, Self::Error>> + Send + '_

Read bytes from the protocol. The default implementation just calls read_bytes_limited with a limit of 0..=usize::MAX but other implementations are free to have a reader wide limit. This will return an error if the bytes could not be read.

fn read_value<V: NixDeserialize>( &mut self, ) -> impl Future<Output = Result<V, Self::Error>> + Send + '_

Read a value from the protocol. Uses NixDeserialize::deserialize to read a value.

fn try_read_value<V: NixDeserialize>( &mut self, ) -> impl Future<Output = Result<Option<V>, Self::Error>> + Send + '_

Read a value from the protocol. Uses NixDeserialize::try_deserialize to read a value. This returns an Option to support graceful shutdown.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T: ?Sized + NixRead> NixRead for &mut T

type Error = <T as NixRead>::Error

fn version(&self) -> ProtocolVersion

fn try_read_number( &mut self, ) -> impl Future<Output = Result<Option<u64>, Self::Error>> + Send + '_

fn try_read_bytes_limited( &mut self, limit: RangeInclusive<usize>, ) -> impl Future<Output = Result<Option<Bytes>, Self::Error>> + Send + '_

fn try_read_bytes( &mut self, ) -> impl Future<Output = Result<Option<Bytes>, Self::Error>> + Send + '_

fn read_number( &mut self, ) -> impl Future<Output = Result<u64, Self::Error>> + Send + '_

fn read_bytes_limited( &mut self, limit: RangeInclusive<usize>, ) -> impl Future<Output = Result<Bytes, Self::Error>> + Send + '_

fn read_bytes( &mut self, ) -> impl Future<Output = Result<Bytes, Self::Error>> + Send + '_

fn try_read_value<V: NixDeserialize>( &mut self, ) -> impl Future<Output = Result<Option<V>, Self::Error>> + Send + '_

fn read_value<V: NixDeserialize>( &mut self, ) -> impl Future<Output = Result<V, Self::Error>> + Send + '_

Implementors

impl<R> NixRead for NixReader<R>

where R: AsyncReadExt + Send + Unpin,

type Error = Error