Struct nvim_oxi::String

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

Binding to the string type used by Neovim.

Implementations

impl String

pub fn new() -> String

Creates a new empty string.

pub fn from_bytes(vec: Vec<u8, Global>) -> String

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 i8

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, Global>

Converts the String into a byte vector, consuming it.

pub fn into_string(self) -> Result<String, 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) -> String

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for String

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

Formats the value using the given formatter.

impl Default for String

fn default() -> String

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for String

fn deserialize<D>(
    deserializer: D
) -> Result<String, <D as Deserializer<'de>>::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for String

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

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

Converts to this type from the input type.

impl From<ContextType> for String

fn from(ctx: ContextType) -> String

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<ExtmarkHlMode> for String

fn from(mode: ExtmarkHlMode) -> String

Converts to this type from the input type.

impl From<ExtmarkVirtTextPosition> for String

fn from(pos: ExtmarkVirtTextPosition) -> String

Converts to this type from the input type.

impl From<Mode> for String

fn from(mode: Mode) -> String

Converts to this type from the input type.

impl From<MouseAction> for String

fn from(action: MouseAction) -> String

Converts to this type from the input type.

impl From<MouseButton> for String

fn from(action: MouseButton) -> String

Converts to this type from the input type.

impl From<OptionScope> for String

fn from(ctx: OptionScope) -> String

Converts to this type from the input type.

impl From<PathBuf> for String

fn from(path: PathBuf) -> String

Converts to this type from the input type.

impl From<RegisterType> for String

fn from(reg_type: RegisterType) -> String

Converts to this type from the input type.

impl From<String> for Object

fn from(string: String) -> Object

Converts to this type from the input type.

impl From<String> for String

fn from(string: String) -> String

Converts to this type from the input type.

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

fn from(vec: Vec<u8, Global>) -> String

Converts to this type from the input type.

impl From<char> for String

fn from(ch: char) -> String

Converts to this type from the input type.

impl FromObject for String

fn from_object(obj: Object) -> Result<String, Error>

impl Hash for String

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,

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.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<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 ==.

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

This method 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

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

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

This method 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

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

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

This method 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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

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

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

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

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

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

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

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

unsafe fn pop(lstate: *mut lua_State) -> Result<String, Error>

Pops the value at the top of the stack.

impl Pushable for String

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

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

impl Eq for String

impl StructuralEq for String