Struct String

#[repr(C)]
pub struct String { /* private fields */ }

Binding to the string type used by Neovim.

Unlike Rust’s String, this type is not guaranteed to contain valid UTF-8 byte sequences, it can contain null bytes, and it is null-terminated.

Implementations

impl String

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

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

Returns a pointer to the String’s buffer.

pub fn as_nvim_str(&self) -> NvimStr<'_>

Returns an NvimStr view of this String.

pub fn from_bytes(bytes: &[u8]) -> Self

Creates a String from a byte slice by allocating bytes.len() + 1 bytes of memory and copying the contents of bytes into it, followed by a null byte.

pub unsafe fn from_raw_parts(data: *const c_char, len: usize) -> Self

Creates a String 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 String has a length of zero.

pub fn len(&self) -> usize

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

pub fn new() -> Self

Creates a new, empty String.

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

Forces the length of the string to be new_len.

Safety

Same as NvimStr::set_len.

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

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

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

Converts the String into Rust’s std::string::String. If it already holds a valid UTF-8 byte sequence no allocation is made. If it doesn’t the String is copied and all invalid sequences are replaced with �.

Trait Implementations

impl Clone for String

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for String

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

Formats the value using the given formatter.

impl Default for String

fn default() -> Self

Returns the “default value” for a type.

impl Display for String

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

Formats the value using the given formatter.

impl Drop for String

fn drop(&mut self)

Executes the destructor for this type.

impl From<&Path> for String

fn from(path: &Path) -> Self

Converts to this type from the input type.

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

fn from(string: &'a NvimString) -> Self

Converts to this type from the input type.

impl From<&str> for String

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Cow<'_, str>> for String

fn from(moo: Cow<'_, str>) -> Self

Converts to this type from the input type.

impl From<String> for Object

fn from(string: NvimString) -> Self

Converts to this type from the input type.

impl From<String> for PathBuf

fn from(nstr: String) -> Self

Converts to this type from the input type.

impl From<String> for String

fn from(s: StdString) -> Self

Converts to this type from the input type.

impl From<char> for String

fn from(ch: char) -> Self

Converts to this type from the input type.

impl Hash for String

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 String

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

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<String> for &str

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

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

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

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

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

fn partial_cmp(&self, other: &String) -> 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 Poppable for String

unsafe fn pop(lstate: *mut State) -> Result<Self, Error>

Pops the value at the top of the stack.

impl Pushable for String

unsafe fn push(self, lstate: *mut State) -> Result<c_int, Error>

Pushes all its values on the Lua stack, returning the number of values that it pushed.

impl TryFrom<Object> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(obj: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for String

impl StructuralPartialEq for String