Struct swimos_encoding::BytesStr

pub struct BytesStr(/* private fields */);

A string based on a sub-range within a Bytes buffer. The bytes are guaranteed to contain valid UTF-8. The purpose of this type is to allow a tokio_util::codec::Decoders to return a string from its input buffer without performing a copy or an allocation and without a lifetime dependency on the buffer.

Implementations

impl BytesStr

pub fn try_wrap(bytes: Bytes) -> Result<Self, Bytes>

Attempt to wrap a buffer as a bytes string. If the buffer does not contain only valid UTF-8, the raw buffer is returned instead.

pub const fn from_static_str(content: &'static str) -> BytesStr

Create a bytes string from a static string (which is guaranteed to be valid).

impl BytesStr

pub fn as_str(&self) -> &str

Trait Implementations

impl AsRef<str> for BytesStr

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for BytesStr

fn clone(&self) -> BytesStr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BytesStr

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

Formats the value using the given formatter.

impl Default for BytesStr

fn default() -> BytesStr

Returns the “default value” for a type.

impl Display for BytesStr

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

Formats the value using the given formatter.

impl From<&str> for BytesStr

fn from(string: &str) -> Self

Converts to this type from the input type.

impl From<BytesStr> for Bytes

fn from(value: BytesStr) -> Self

Converts to this type from the input type.

impl From<String> for BytesStr

fn from(string: String) -> Self

Converts to this type from the input type.

impl PartialEq<String> for BytesStr

fn eq(&self, other: &String) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for BytesStr

fn eq(&self, other: &str) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for BytesStr

fn eq(&self, other: &BytesStr) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Bytes> for BytesStr

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(value: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFromUtf8Bytes for BytesStr

fn try_from_utf8_bytes(bytes: Bytes) -> Result<Self, Utf8Error>

impl Eq for BytesStr

impl StructuralPartialEq for BytesStr