Struct Utf8CString

pub struct Utf8CString {
    string: Box<CStr>,
}

A string that is guaranteed to be UTF-8 and NUL-terminated, for fast access as either type.

Fields

string: Box<CStr>

The body of this string.

Safety

INVARIANT: This string must be valid UTF-8.

(We do not yet depend on this invariant for safety in our rust code, but we do promise in our C ffi that it will hold.)

Implementations

impl Utf8CString

pub(crate) fn as_ptr(&self) -> *const c_char

Expose this Utf8CStr as a C string.

impl Utf8CString

fn try_from_bytes(bytes: &[u8]) -> Result<Self, Utf8CStringFromBytesError>

Try to construct a new Utf8CString from a given byte slice.

Trait Implementations

impl AsRef<CStr> for Utf8CString

fn as_ref(&self) -> &CStr

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

impl AsRef<str> for Utf8CString

fn as_ref(&self) -> &str

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

impl Clone for Utf8CString

fn clone(&self) -> Utf8CString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Utf8CString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Utf8CString

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Utf8CString

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

Formats the value using the given formatter.

impl From<ErrorResponse> for Utf8CString

fn from(value: ErrorResponse) -> Self

Converts to this type from the input type.

impl From<ObjectId> for Utf8CString

fn from(value: ObjectId) -> Self

Converts to this type from the input type.

impl From<SuccessResponse> for Utf8CString

fn from(value: SuccessResponse) -> Self

Converts to this type from the input type.

impl From<UpdateResponse> for Utf8CString

fn from(value: UpdateResponse) -> Self

Converts to this type from the input type.

impl From<Utf8CString> for ObjectId

fn from(value: Utf8CString) -> Self

Converts to this type from the input type.

impl Hash for Utf8CString

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Utf8CString

fn cmp(&self, other: &Utf8CString) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Utf8CString

fn eq(&self, other: &Utf8CString) -> 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 PartialOrd for Utf8CString

fn partial_cmp(&self, other: &Utf8CString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Utf8CString

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for Utf8CString

type Error = NulError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Utf8CString

impl StructuralPartialEq for Utf8CString