Struct NvimStr

#[repr(C)]
pub struct NvimStr<'a> { /* private fields */ }

A borrowed version of NvimString.

Values of this type can be created by calling as_nvim_str on a NvimString or by converting a CStr.

Implementations

impl<'a> NvimStr<'a>

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

Converts the NvimStr into a byte slice, not including the final null byte.

If you want the final null byte to be included in the slice, use as_bytes_with_nul instead.

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

Converts the NvimStr into a byte slice, including the final null byte.

If you don’t want the final null byte to be included in the slice, use as_bytes instead.

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

Returns a raw pointer to the NvimStr’s buffer.

pub unsafe fn from_raw_parts(data: *const i8, len: usize) -> NvimStr<'a>

Creates an NvimStr from a pointer to the underlying data and a length.

Safety

The caller must ensure that the pointer is valid for len + 1 elements and that the last element is a null byte.

pub fn is_empty(&self) -> bool

Returns true if the NvimStr has a length of zero, not including the final null byte.

pub const fn len(&self) -> usize

Returns the length of the NvimStr, not including the final null byte.

pub const unsafe fn set_len(&mut self, new_len: usize)

Returns the length of the NvimStr, not including the final null byte.

Safety

The caller must ensure that the bytes at old_len..new_len are initialized.

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

Yields a string slice if the NvimStr’s contents are valid UTF-8.

pub fn to_string_lossy(&self) -> Cow<'_, str>

Converts the NvimStr into a String.

If it already holds a valid UTF-8 byte sequence no allocation is made. If it doesn’t, the contents of the NvimStr are is copied and all invalid sequences are replaced with �.

Trait Implementations

impl<'a> Clone for NvimStr<'a>

fn clone(&self) -> NvimStr<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NvimStr<'_>

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

Formats the value using the given formatter.

impl Display for NvimStr<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a CStr> for NvimStr<'a>

fn from(cstr: &'a CStr) -> NvimStr<'a>

Converts to this type from the input type.

impl<'a> From<&'a String> for NvimStr<'a>

fn from(string: &'a String) -> NvimStr<'a>

Converts to this type from the input type.

impl Hash for NvimStr<'_>

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

where H: Hasher,

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 NvimStr<'_>

fn cmp(&self, other: &NvimStr<'_>) -> 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<&str> for NvimStr<'_>

fn eq(&self, other: &&str) -> 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 PartialEq<NvimStr<'_>> for &str

fn eq(&self, other: &NvimStr<'_>) -> 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 PartialEq for NvimStr<'_>

fn eq(&self, other: &NvimStr<'_>) -> 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 NvimStr<'_>

fn partial_cmp(&self, other: &NvimStr<'_>) -> 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<'a> Copy for NvimStr<'a>

impl Eq for NvimStr<'_>