Struct JSStr

pub struct JSStr { /* private fields */ }

Wrapper around str that ensures it contains syntactically valid Javascript. This is the borrowed version of JSString so &JSStr is to JSString what &str is to String

Implementations

impl JSStr

pub fn new(js: &str) -> Result<&Self, JSParseError>

Checks if the content of js is syntactically valid Javascript before coersing it to &JSStr

Examples

use include_js::JSStr;
 
let js_str = JSStr::new("function f() {}");
assert!(js_str.is_ok());

use include_js::JSStr;

let js_str = JSStr::new("#include <vector>");
assert!(js_str.is_err());

pub const unsafe fn new_unchecked(js: &str) -> &Self

Coerses js directly into a &JSStr without checking for validity

pub fn as_str(&self) -> &str

Converts the &JSStr back into an &str, this should be a noop.

Trait Implementations

impl AsRef<JSStr> for JSStr

fn as_ref(&self) -> &JSStr

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

impl AsRef<JSStr> for JSString

fn as_ref(&self) -> &JSStr

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

impl AsRef<str> for JSStr

fn as_ref(&self) -> &str

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

impl Borrow<JSStr> for JSString

fn borrow(&self) -> &JSStr

Immutably borrows from an owned value.

impl<'a> Into<&'a str> for &'a JSStr

fn into(self) -> &'a str

Converts this type into the (usually inferred) input type.

impl ToOwned for JSStr

type Owned = JSString

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<'a> TryFrom<&'a str> for &'a JSStr

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Performs the conversion.