Struct uapi::Ustring

pub struct Ustring { /* fields omitted */ }

Thin wrapper for a Vec<u8> that has a trailing nul byte

NOTE: Ustring derefs to Ustr derefs to Bstr derefs to [u8]. Rustdoc might not show all available methods.

Ustring is optimized so that it can be created without allocating.

See also the crate documentation.

Implementations

impl Ustring

pub fn new() -> Ustring

Creates a new, empty Ustring

NOTE: This function does not allocate

pub fn reserve(&mut self, num: usize)

Reserves space for num additional bytes in Ustring

See Vec::reserve

pub fn reserve_exact(&mut self, additional: usize)

Reserves space for num additional bytes in Ustring

See Vec::reserve_exact

pub fn capacity(&self) -> usize

Returns the capacity of the underlying Vector excluding the trailing nul byte

pub unsafe fn with_unused<F>(&mut self, f: F) -> Result<usize> where
    F: FnOnce(&mut [u8]) -> Result<usize>, 

Passes the unused portion of the underlying vector to a callback

The size of the slice is self.capacity() - self.len().

The callback should return the number of bytes written to the the slice. If the callback returns an error, the Ustring is guaranteed to be unchanged.

Safety

• f must not read from the slice
• f must initialize the slice up to (excluding) the returned index

pub fn from_vec(s: Vec<u8>) -> Self

Turns s into an Ustring by appending a nul byte.

pub unsafe fn from_vec_with_nul_unchecked(s: Vec<u8>) -> Self

Transmutes the argument into Ustring

Safety

s must be empty or contain a trailing nul byte

pub fn from_vec_with_nul(s: Vec<u8>) -> Result<Self, Vec<u8>>

Checks that s is empty or has a trailing nul byte and then turns it into an Ustring

pub fn into_vec(self) -> Vec<u8>

Returns the underlying Vec<u8> after removing the trailing nul byte

pub fn into_vec_with_nul(self) -> Vec<u8>

Returns the underlying Vec<u8> without removing the trailing nul byte

pub fn from_string(s: String) -> Self

Shortcut for Ustring::from_vec(s.into_bytes())

pub fn from_string_with_nul(s: String) -> Result<Self, String>

Shortcut for Ustring::from_vec_with_nul(s.into_bytes())

pub fn into_string(self) -> Result<String, Self>

Tries to turn self into a String after removing the trailing nul byte

pub fn into_string_with_nul(self) -> Result<String, Self>

Tries to turn self into a String without removing the trailing nul byte

pub fn from_c_string(s: CString) -> Self

Shortcut for Ustring::from_vec(s.into_bytes())

pub fn into_c_string(self) -> Result<CString, (usize, Self)>

Tries to turn self into a CString

On error, the usize is the index of the first interior nul byte.

pub fn from_os_string(s: OsString) -> Self

Shortcut for Ustring::from_vec(s.into_vec())

pub fn from_os_string_with_nul(s: OsString) -> Result<Self, OsString>

Shortcut for Ustring::from_vec_with_nul(s.into_vec())

pub fn into_os_string(self) -> OsString

Shortcut for OsString::from_vec(self.into_vec())

pub fn into_os_string_with_nul(self) -> OsString

Shortcut for OsString::from_vec(self.into_vec_with_nul())

pub fn from_path_buf(s: PathBuf) -> Self

Shortcut for Ustring::from_os_string(s.into_os_string())

pub fn from_path_buf_with_nul(s: PathBuf) -> Result<Self, PathBuf>

Shortcut for Ustring::from_os_string_with_nul(s.into_os_string())

pub fn into_path_buf(self) -> PathBuf

Shortcut for PathBuf::from(self.into_os_string())

pub fn into_path_buf_with_nul(self) -> PathBuf

Shortcut for PathBuf::from(self.into_os_string_with_nul())

pub fn push<T: Bytes + ?Sized>(&mut self, bytes: &T)

Appends the bytes

For example:

let mut s = format_ustr!("hello ");
s.push("world");
assert_eq!("hello world", &s);

pub fn as_ustr(&self) -> &Ustr

Returns self as a &Ustr

pub fn as_ustr_mut(&mut self) -> &mut Ustr

Returns self as a &mut Ustr

Methods from Deref<Target = Ustr>

pub fn is_null(&self) -> bool

Returns true iff this Ustr was constructed via Ustr::null()

pub fn as_bytes_with_nul(&self) -> &[u8]

Transmutes self into &[u8]

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

Shortcut for CStr::from_bytes_with_nul(self.as_bytes_with_nul())

pub fn as_os_str_with_nul(&self) -> &OsStr

Shortcut for OsStr::from_bytes(self.as_bytes_with_nul())

pub fn as_path_with_nul(&self) -> &Path

Shortcut for Path::new(self.as_os_str_with_nul())

pub fn len_with_nul(&self) -> usize

Returns the length of the underlying [u8] including the trailing nul byte

pub fn as_bstr(&self) -> &Bstr

Returns the &Bstr created by dropping the trailing nul byte

pub fn as_bstr_mut(&mut self) -> &mut Bstr

Returns the &mut Bstr created by dropping the trailing nul byte

pub fn as_ptr_null(&self) -> *const c_char

Returns ptr::null() if self.is_null(), otherwise self.as_ptr().

Trait Implementations

impl AsMut<[u8]> for Ustring

fn as_mut(&mut self) -> &mut [u8]

Performs the conversion.

impl AsRef<[u8]> for Ustring

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<OsStr> for Ustring

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for Ustring

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsUstr for Ustring

fn as_ustr(&self) -> &Ustr

Perform the conversion

impl Borrow<Bstr> for Ustring

fn borrow(&self) -> &Bstr

Immutably borrows from an owned value.

impl Borrow<Ustr> for Ustring

fn borrow(&self) -> &Ustr

Immutably borrows from an owned value.

impl Debug for Ustring

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

Formats the value using the given formatter.

impl Default for Ustring

fn default() -> Self

Returns the "default value" for a type.

impl Deref for Ustring

type Target = Ustr

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Ustring

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Eq for Ustring

impl From<CString> for Ustring

fn from(s: CString) -> Self

Performs the conversion.

impl From<OsString> for Ustring

fn from(s: OsString) -> Self

Performs the conversion.

impl From<PathBuf> for Ustring

fn from(s: PathBuf) -> Self

Performs the conversion.

impl From<String> for Ustring

fn from(s: String) -> Self

Performs the conversion.

impl From<Ustring> for Vec<u8>

fn from(s: Ustring) -> Self

Performs the conversion.

impl From<Ustring> for OsString

fn from(s: Ustring) -> Self

Performs the conversion.

impl From<Ustring> for PathBuf

fn from(s: Ustring) -> Self

Performs the conversion.

impl From<Vec<u8>> for Ustring

fn from(s: Vec<u8>) -> Self

Performs the conversion.

impl Hash for Ustring

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, 

Feeds a slice of this type into the given [Hasher].

impl<'a> IntoUstr<'a> for &'a Ustring

fn into_ustr(self) -> Cow<'a, Ustr>

Converts self into Cow<'a, Ustr>

impl IntoUstr<'static> for Ustring

fn into_ustr(self) -> Cow<'static, Ustr>

Converts self into Cow<'a, Ustr>

impl Ord for Ustring

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<[u8]> for Ustring

fn eq(&self, other: &[u8]) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Bstr> for Ustring

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<CStr> for Ustring

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<CString> for Ustring

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<OsStr> for Ustring

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<OsString> for Ustring

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Path> for Ustring

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<PathBuf> for Ustring

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<String> for Ustring

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustr> for Ustring

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for [u8]

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for Bstr

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for Ustr

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for Ustring

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

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

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

This method tests for !=.

impl PartialEq<Ustring> for CStr

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for OsStr

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for Path

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for Vec<u8>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for String

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for CString

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for OsString

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Ustring> for PathBuf

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Vec<u8>> for Ustring

fn eq(&self, other: &Vec<u8>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<str> for Ustring

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Ustring> for Ustring

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for Ustring

impl StructuralPartialEq for Ustring

impl TryFrom<Ustring> for String

type Error = Ustring

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Ustring> for CString

type Error = (usize, Ustring)

The type returned in the event of a conversion error.

fn try_from(s: Ustring) -> Result<Self, Self::Error>

Performs the conversion.