Struct nvim_types::String

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

A particular string type used internally by Neovim.

Implementations

impl String

pub const fn new() -> Self

Creates a new empty string.

pub fn from_bytes(vec: Vec<u8>) -> Self

Creates a String from a byte vector.

pub const fn is_empty(&self) -> bool

Returns true if the String has a length of zero, and false otherwise.

pub const fn len(&self) -> usize

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

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

Returns a pointer pointing to the byte of the string.

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

Returns a byte slice of this String’s contents.

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

Returns a string slice of this String’s contents. Fails if it doesn’t contain a valid UTF-8 byte sequence.

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 �.

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

Converts the String into a byte vector, consuming it.

pub fn into_string(self) -> Result<StdString, FromUtf8Error>

Converts the String into Rust’s std::string::String, consuming it. Fails if it doesn’t contain a valid UTF-8 byte sequence.

Trait Implementations

impl Clone for String

fn clone(&self) -> Self

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

fn from(str: &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<PathBuf> for String

fn from(path: PathBuf) -> 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(string: StdString) -> Self

Converts to this type from the input type.

impl From<Vec<u8, Global>> for String

fn from(vec: Vec<u8>) -> 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 Ord for String

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<&str> for String

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

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

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

This method tests for !=.

impl PartialEq<String> for String

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

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

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

This method tests for !=.

impl PartialEq<String> for String

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

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

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

This method tests for !=.

impl PartialEq<str> for String

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

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

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

This method tests for !=.

impl PartialOrd<String> 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

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

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

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

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

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

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

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

impl TryFrom<Object> for NvimString

type Error = FromObjectError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for StdString

type Error = FromUtf8Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for String

impl StructuralEq for String