Struct FrameSlice

pub struct FrameSlice<'frame> { /* private fields */ }

A borrowed reference to a part of the frame.

Implementations

impl<'frame> FrameSlice<'frame>

pub fn new(frame: &'frame Bytes) -> Self

Creates a new FrameSlice from a reference of a Bytes object.

This method is exposed to allow writing deserialization tests for custom types.

pub fn new_empty() -> Self

Creates an empty FrameSlice.

pub fn is_empty(&self) -> bool

Returns true if the slice has length of 0.

pub fn as_slice(&self) -> &'frame [u8]

Returns the subslice.

pub fn as_slice_mut(&mut self) -> &mut &'frame [u8]

Returns a mutable reference to the subslice.

pub fn as_original_frame_bytes(&self) -> &'frame Bytes

Returns a reference to the Bytes object which encompasses the whole frame slice.

The Bytes object will usually be larger than the slice returned by FrameSlice::as_slice. If you wish to obtain a new Bytes object that points only to the subslice represented by the FrameSlice object, see FrameSlice::to_bytes.

pub fn to_bytes(&self) -> Bytes

Returns a new Bytes object which is a subslice of the original Bytes frame slice object.

pub fn read_cql_bytes( &mut self, ) -> Result<Option<FrameSlice<'frame>>, LowLevelDeserializationError>

Reads and consumes a [bytes] item from the beginning of the frame, returning a subslice that encompasses that item.

If the operation fails then the slice remains unchanged.

pub fn read_n_bytes( &mut self, count: usize, ) -> Result<Option<FrameSlice<'frame>>, LowLevelDeserializationError>

Reads and consumes a fixed number of bytes from the beginning of the frame, returning a subslice that encompasses them.

If this slice is empty, returns Ok(None). Otherwise, if the slice does not contain enough data, it returns Err. If the operation fails then the slice remains unchanged.

Trait Implementations

impl<'frame> Clone for FrameSlice<'frame>

fn clone(&self) -> FrameSlice<'frame>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'frame> Debug for FrameSlice<'frame>

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

Formats the value using the given formatter.

impl<'frame> From<FrameSlice<'frame>> for BytesSequenceIterator<'frame>

fn from(slice: FrameSlice<'frame>) -> Self

Converts to this type from the input type.

impl<'frame> Copy for FrameSlice<'frame>