Struct CompletionTrigger 

pub struct CompletionTrigger(/* private fields */);

The text that triggered a completion request: not empty and at most MAX_TRIGGER_CHARACTER_BYTES bytes.

Whitespace is a valid trigger (a space triggers completion in some languages), so only the empty string is refused, not a blank one. That is why it is not a BoundedText, which refuses blank text.

Examples

use mcpls_core::bridge::CompletionTrigger;
use mcpls_core::config::InvalidBoundedText;

assert_eq!(CompletionTrigger::new("->")?.as_str(), "->");
assert!(CompletionTrigger::new(" ").is_ok());
assert_eq!(CompletionTrigger::new("").unwrap_err().reason, InvalidBoundedText::Blank);
assert!(CompletionTrigger::new("123456789").is_err());

Implementations

impl CompletionTrigger

pub fn new(raw: impl Into<String>) -> Result<Self, InvalidTextField>

Validates raw.

Errors

InvalidTextField naming trigger when raw is empty or exceeds MAX_TRIGGER_CHARACTER_BYTES.

pub fn into_string(self) -> String

The trigger text, owned.

impl CompletionTrigger

pub fn as_str(&self) -> &str

The validated text.

Trait Implementations

impl AsRef<str> for CompletionTrigger

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for CompletionTrigger

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for CompletionTrigger

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 CompletionTrigger

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompletionTrigger

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CompletionTrigger

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

Formats the value using the given formatter.

impl Eq for CompletionTrigger

impl From<CompletionTrigger> for String

fn from(value: CompletionTrigger) -> Self

Converts to this type from the input type.

impl FromStr for CompletionTrigger

type Err = InvalidTextField

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for CompletionTrigger

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for CompletionTrigger

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for CompletionTrigger

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CompletionTrigger

impl TryFrom<String> for CompletionTrigger

type Error = InvalidTextField

The type returned in the event of a conversion error.

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

Performs the conversion.