Struct fastobo::ast::QuotedString

pub struct QuotedString { /* fields omitted */ }

A string enclosed by quotes, used for definitions.

This type is mostly just a wrapper for String that patches FromStr and Display so that it can read and write quoted strings in OBO documents.

Usage

Use FromStr to parse the serialized representation of a QuotedString, and QuotedString::new to create a quoted string with its content set from an Into<String> implementor.

To get the the unescaped String, use QuotedString::into_string, or use ToString::to_string to obtained a serialized (escaped) version of the quoted string.

Example

let s = QuotedString::new("Hello, world!");
assert_eq!(s.as_str(), "Hello, world!");
assert_eq!(s.to_string(), "\"Hello, world!\"");

Methods

impl QuotedString

pub fn new<S>(s: S) -> Self where
    S: Into<String>, 

Create a new QuotedString from an unescaped string.

pub fn as_str(&self) -> &str

Extracts a string slice containing the QuotedString value.

pub fn into_string(self) -> String

Retrieve the underlying unescaped string from the QuotedString.

Methods from Deref<Target = QuotedStr>

Trait Implementations

impl<'i> FromPair<'i> for QuotedString

const RULE: Rule

unsafe fn from_pair_unchecked(pair: Pair<Rule>) -> Result<Self, SyntaxError>

Create a new instance from a Pair without checking the rule.

fn from_pair(pair: Pair<'i, Rule>) -> Result<Self, SyntaxError>

Create a new instance from a Pair.

impl<'a> Share<'a, &'a QuotedStr> for QuotedString

fn share(&'a self) -> &'a QuotedStr

impl From<String> for QuotedString

fn from(__inner: String) -> Self

Performs the conversion.

impl<'_> From<&'_ str> for QuotedString

fn from(s: &str) -> Self

Performs the conversion.

impl PartialEq<QuotedString> for QuotedString

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

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

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

This method tests for !=.

impl PartialEq<str> for QuotedString

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<String> for QuotedString

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Clone for QuotedString

fn clone(&self) -> QuotedString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AsRef<String> for QuotedString

fn as_ref(&self) -> &String

Performs the conversion.

impl AsRef<QuotedString> for QuotedString

fn as_ref(&self) -> &QuotedString

Performs the conversion.

impl AsRef<str> for QuotedString

fn as_ref(&self) -> &str

Performs the conversion.

impl AsRef<QuotedStr> for QuotedString

fn as_ref(&self) -> &QuotedStr

Performs the conversion.

impl PartialOrd<QuotedString> for QuotedString

fn partial_cmp(&self, other: &QuotedString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

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

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

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

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

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

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

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

impl Eq for QuotedString

impl Into<String> for QuotedString

fn into(self) -> String

Performs the conversion.

impl Ord for QuotedString

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Deref for QuotedString

type Target = QuotedStr

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for QuotedString

fn fmt(&self, f: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl Debug for QuotedString

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

Formats the value using the given formatter.

impl FromStr for QuotedString

type Err = SyntaxError

The associated error which can be returned from parsing.

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

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

impl Hash for QuotedString

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, 

Feeds a slice of this type into the given [Hasher].

impl Borrow<QuotedStr> for QuotedString

fn borrow(&self) -> &QuotedStr

Immutably borrows from an owned value.

impl OpaqueTypedef for QuotedString

type Inner = String

Inner type.

type Error = Infallible

Validation error type.

unsafe fn from_inner_unchecked(__inner: Self::Inner) -> Self

Creates a new value from the inner value without validation.

fn try_from_inner(__inner: Self::Inner) -> Result<Self, Self::Error>

Tries to create a new value from the inner value with validation.

fn from_inner(__inner: Self::Inner) -> Self

Creates a new value from the inner value with validation.

fn into_inner(self) -> Self::Inner

Takes and returns the inner value with its ownership.

fn as_inner(&self) -> &Self::Inner

Returns the reference to the inner value.

unsafe fn as_inner_mut(&mut self) -> &mut Self::Inner

Returns the mutable reference to the inner value.