Struct libuv::buf::ReadonlyBuf

pub struct ReadonlyBuf { /* fields omitted */ }

Readonly buffer data type.

Implementations

impl ReadonlyBuf

pub fn is_allocated(&self) -> bool

Returns true if the internal buffer is initialized

pub fn dealloc(&mut self)

Deallocate the internal buffer, but leave the Buf intact. Even though this is a "readonly" Buf, the internal storage can still be deallocated. This oddity is an unfortunate side-effect of the libuv API: for example, StreamHandle::read_start calls the allocate callback to create a Buf, then passes that Buf to the read callback as a ReadonlyBuf. You could run dealloc() in the read callback to deallocate the internal buffer - the allocate callback takes ownership of the actual Buf struct, so you don't need to worry about that.

pub fn as_c_str(&self) -> Result<&CStr, EmptyBufError>

Convert the Buf to a CStr. Returns an error if the Buf is empty. Data contained within the ReadonlyBuf must be null-terminated or this will fail!

pub fn to_string_lossy(&self) -> Result<Cow<'_, str>, EmptyBufError>

Convert the Buf to a string. Returns an error if the Buf is empty. Data contained within the ReadonlyBuf must be null-terminated or this will fail!

pub fn to_str(&self, len: usize) -> Result<&str, Box<dyn Error>>

Convert data in the Buf to a &str. Returns an error if the Buf is empty or the data is not valid utf8. Data does not need to be null-terminated because only the first len bytes will be used to create the string.

Trait Implementations

impl BufTrait for ReadonlyBuf

fn readonly(&self) -> ReadonlyBuf

impl Clone for ReadonlyBuf

fn clone(&self) -> ReadonlyBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ReadonlyBuf

impl From<Buf> for ReadonlyBuf

fn from(buf: Buf) -> ReadonlyBuf

Performs the conversion.

impl Index<Range<usize>> for ReadonlyBuf

type Output = [u8]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for ReadonlyBuf

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for ReadonlyBuf

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeInclusive<usize>> for ReadonlyBuf

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for ReadonlyBuf

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for ReadonlyBuf

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeToInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for ReadonlyBuf

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.