Struct StrBytes

#[non_exhaustive]
pub struct StrBytes { /* private fields */ }

UTF-8 string byte buffer representation with validation amortization. When StrBytes is constructed from a &str or String, its underlying bytes are assumed to be valid UTF-8. Otherwise, if constructed from a byte source, the construction will be fallible.

Example construction from a &str:

use aws_smithy_types::str_bytes::StrBytes;

let value: StrBytes = "example".into();
assert_eq!("example", value.as_str());
assert_eq!(b"example", &value.as_bytes()[..]);

Example construction from Bytes:

use bytes::Bytes;
use aws_smithy_types::str_bytes::StrBytes;

let bytes = Bytes::from_static(b"example");
let value: StrBytes = bytes.try_into().expect("valid utf-8");
assert_eq!("example", value.as_str());
assert_eq!(b"example", &value.as_bytes()[..]);

Implementations

impl StrBytes

pub fn as_bytes(&self) -> &Bytes

Returns the underlying Bytes representation.

pub fn as_str(&self) -> &str

Returns the StrBytes value as a &str.

pub fn try_copy_from_slice(slice: &[u8]) -> Result<Self, Utf8Error>

Tries to create a StrBytes from a slice, or returns a Utf8Error if the slice is not valid UTF-8.

pub fn copy_from_str(string: &str) -> Self

Creates a StrBytes from a &str.

Trait Implementations

impl Clone for StrBytes

fn clone(&self) -> StrBytes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StrBytes

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

Formats the value using the given formatter.

impl From<&'static str> for StrBytes

fn from(value: &'static str) -> Self

Converts to this type from the input type.

impl From<String> for StrBytes

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for StrBytes

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&'static [u8]> for StrBytes

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(value: &'static [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Bytes> for StrBytes

type Error = Utf8Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8>> for StrBytes

type Error = Utf8Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for StrBytes

impl StructuralPartialEq for StrBytes