Struct uapi::Ustr

#[repr(transparent)]pub struct Ustr { /* fields omitted */ }

Thin wrapper for a [u8] that has a trailing nul byte

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

See also the crate documentation.

Implementations

impl Ustr

pub fn empty() -> &'static Self

Returns an empty Ustr

pub fn null() -> &'static Self

Returns the unique &Ustr for which self.is_null() == true

Apart from self.is_null(), the returned value is indistinguishable from Ustr::empty().

pub fn is_null(&self) -> bool

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

pub unsafe fn from_bytes_unchecked(s: &[u8]) -> &Self

Transmutes the argument into &Ustr

Safety

s must have a trailing nul byte.

pub unsafe fn from_bytes_unchecked_mut(s: &mut [u8]) -> &mut Self

Transmutes the argument into &mut Ustr

Safety

s must have a trailing nul byte.

pub fn from_bytes(s: &[u8]) -> Option<&Self>

Converts the argument into &Ustr after checking that it has a trailing nul byte

Otherwise None is returned.

pub fn from_bytes_mut(s: &mut [u8]) -> Option<&mut Self>

Converts the argument into &mut Ustr after checking that it has a trailing nul byte

Otherwise None is returned.

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

Transmutes self into &[u8]

pub fn from_str(s: &str) -> Option<&Self>

Shortcut for Ustr::from_bytes(s.as_bytes())

pub fn from_c_str(s: &CStr) -> &Self

Transmutes the argument into &Ustr

pub unsafe fn from_ptr<'a>(ptr: *const c_char) -> &'a Self

Shortcut for Ustr::from_c_str(CStr::from_ptr(ptr))

Safety

Like CStr::from_ptr

pub unsafe fn from_ptr_mut<'a>(ptr: *mut c_char) -> &'a mut Self

Shortcut for Ustr::from_bytes_unchecked_mut(CStr::from_ptr_mut(ptr).as_bytes_with_nul_mut())

(CStr::from_ptr_mut does not actually exist so check the source if you want to know the truth.)

Safety

Like CStr::from_ptr

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

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

pub fn from_os_str(s: &OsStr) -> Option<&Self>

Shortcut for Ustr::from_bytes(s.as_bytes())

pub fn as_os_str_with_nul(&self) -> &OsStr

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

pub fn from_path(s: &Path) -> Option<&Self>

Shortcut for Ustr::from_os_str(s.as_os_str())

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().

Methods from Deref<Target = Bstr>

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

Transmutes self into &[u8]

pub fn as_bytes_mut(&mut self) -> &mut [u8]

Transmutes self into &mut [u8]

pub fn as_str(&self) -> Result<&str, Utf8Error>

Shortcut for str::from_utf8(self.as_bytes())

pub fn as_os_str(&self) -> &OsStr

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

pub fn as_path(&self) -> &Path

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

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

Shortcut for self.as_bytes().as_ptr()

pub fn as_mut_ptr(&mut self) -> *mut c_char

Shortcut for self.as_mut_bytes().as_mut_ptr()

pub fn len(&self) -> usize

Shortcut for self.as_bytes().len()

pub fn is_empty(&self) -> bool

Shortcut for self.len() == 0

pub fn display(&self) -> impl Display + '_

Shortcut for self.as_path().display()

pub fn to_ustring(&self) -> Ustring

Allocates a new Ustring with the contents of this object

Trait Implementations

impl AsMut<[u8]> for Ustr

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

Performs the conversion.

impl AsRef<[u8]> for Ustr

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

Performs the conversion.

impl AsRef<OsStr> for Ustr

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for Ustr

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<Ustr> for CStr

fn as_ref(&self) -> &Ustr

Performs the conversion.

impl AsUstr for Ustr

fn as_ustr(&self) -> &Ustr

Perform the conversion

impl Borrow<Ustr> for Ustring

fn borrow(&self) -> &Ustr

Immutably borrows from an owned value.

impl Debug for Ustr

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

Formats the value using the given formatter.

impl Deref for Ustr

type Target = Bstr

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Ustr

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

Mutably dereferences the value.

impl Eq for Ustr

impl Hash for Ustr

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 Ustr

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

Converts self into Cow<'a, Ustr>

impl Ord for Ustr

fn cmp(&self, other: &Ustr) -> 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 Ustr

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 Ustr

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 Ustr

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 Ustr

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 Ustr

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 Ustr

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 Ustr

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 Ustr

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 Ustr

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 [u8]

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<Ustr> for str

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<Ustr> for Bstr

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<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<Ustr> for Ustr

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

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

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

This method tests for !=.

impl PartialEq<Ustr> for CStr

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<Ustr> for OsStr

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<Ustr> for Path

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<Ustr> for Vec<u8>

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<Ustr> for String

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<Ustr> for CString

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<Ustr> for OsString

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<Ustr> for PathBuf

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 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<Vec<u8>> for Ustr

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 Ustr

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<Ustr> for Ustr

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Ustr

impl StructuralPartialEq for Ustr

impl ToOwned for Ustr

type Owned = Ustring

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

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

recently added

Uses borrowed data to replace owned data, usually by cloning.