Struct SfString 

pub struct SfString<'a> { /* private fields */ }

A String: the content between the quotes, only \" and \\ escapes.

Examples

use parse_net::sfv::{self, BareItem};

let BareItem::String(s) = sfv::parse_item(b"\"hello\"")?.bare else { unreachable!() };
assert!(s.eq_str("hello"));

Implementations

impl<'a> SfString<'a>

pub const fn raw(&self) -> &'a str

The content as sent, escapes included (ASCII by construction).

Examples

use parse_net::sfv::{self, BareItem};

let BareItem::String(s) = sfv::parse_item(br#""a\"b""#)?.bare else { unreachable!() };
assert_eq!(s.raw(), r#"a\"b"#);

pub const fn as_plain(&self) -> Option<&'a str>

The value with no copy, when it has no escape.

Examples

use parse_net::sfv::{self, BareItem};

let BareItem::String(s) = sfv::parse_item(b"\"plain\"")?.bare else { unreachable!() };
assert_eq!(s.as_plain(), Some("plain"));
let BareItem::String(e) = sfv::parse_item(br#""a\"b""#)?.bare else { unreachable!() };
assert_eq!(e.as_plain(), None);

pub fn unescaped_len(&self) -> usize

The length of the unescaped value.

Examples

use parse_net::sfv::{self, BareItem};

let BareItem::String(s) = sfv::parse_item(br#""a\"b""#)?.bare else { unreachable!() };
assert_eq!(s.raw().len(), 4);
assert_eq!(s.unescaped_len(), 3);

pub fn unescape_into<'b>( &self, out: &'b mut [u8], ) -> Result<&'b str, ParseError>

Writes the unescaped value into out and returns it.

Errors

ErrorKind::BufferTooSmall; nothing is written.

Examples

use parse_net::sfv::{self, BareItem};

let BareItem::String(s) = sfv::parse_item(b"\"a \\\"b\\\"\"")?.bare else { unreachable!() };
let mut buf = [0u8; 8];
assert_eq!(s.unescape_into(&mut buf)?, "a \"b\"");
assert!(s.eq_str("a \"b\""));

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

Whether the unescaped value equals other, with no buffer.

Examples

use parse_net::sfv::{self, BareItem};

let BareItem::String(s) = sfv::parse_item(br#""a\"b""#)?.bare else { unreachable!() };
assert!(s.eq_str("a\"b"));
assert!(!s.eq_str(r#"a\"b"#));

Trait Implementations

impl<'a> Clone for SfString<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for SfString<'a>

impl<'a> Debug for SfString<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for SfString<'a>

impl<'a> Hash for SfString<'a>

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<'a> PartialEq for SfString<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for SfString<'a>