Struct CommonJsStringBuilder 

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

Common JsString builder that accepts multiple variant of string or character.

Originally based on kiesel-js

Implementations

impl<'seg, 'ref_str> CommonJsStringBuilder<'seg>

where 'ref_str: 'seg,

pub const fn new() -> CommonJsStringBuilder<'seg>

Creates a new CommonJsStringBuilder with capacity of zero.

pub fn with_capacity(capacity: usize) -> CommonJsStringBuilder<'seg>

Similar to Vec::with_capacity.

Creates a new CommonJsStringBuilder with given capacity.

pub fn reserve(&mut self, additional: usize)

Similar to Vec::reserve.

Reserves additional capacity for the inner vector.

pub fn reserve_exact(&mut self, additional: usize)

Similar to Vec::reserve_exact.

Reserves the minimum capacity for the inner vector.

pub fn push<T>(&mut self, seg: T)

where T: Into<Segment<'ref_str>>,

Appends string segments to the back of the inner vector.

pub fn is_ascii(&self) -> bool

Checks if all string segments contains only ASCII bytes.

pub fn len(&self) -> usize

Returns the number of string segment in inner vector.

pub fn is_empty(&self) -> bool

Returns true if this CommonJsStringBuilder has a length of zero, and false otherwise.

pub fn build_from_latin1(&self) -> Option<JsString>

Builds Latin1 encoded JsString from string segments.

This doesn’t consume the builder itself because it may fails to build and the caller may wants to keep the builder for further operations.

This processes the following types of segments:

• Segment::String(s): Encodes the string if it can be represented in Latin1.
• Segment::Str(s): Encodes the string slice if it can be represented in Latin1.
• Segment::Latin1(b): Encodes the byte if it’s within the ASCII range.
• Segment::CodePoint(ch): Encodes the code point by converting it to a byte if it’s within the ASCII range.

Return None if any segment fails to encode.

pub fn build_from_utf16(self) -> JsString

Builds Utf-16 encoded JsString from string segments.

pub fn build(self) -> JsString

Builds JsString from CommonJsStringBuilder,

This function first checks if the instance is empty:

• If it is empty, it returns the default JsString.
• If it contains only ASCII characters, it safely encodes it as Latin1.
• If it contains non-ASCII characters, it falls back to encoding using UTF-16.

pub unsafe fn build_as_latin1(self) -> JsString

Builds Latin1 encoded JsString from CommonJsStringBuilder, return None if segments can’t be encoded as Latin1

Safety

Caller must ensure that the string segments can be Latin1 encoded.

If string segments can’t be Latin1 encoded, it may lead to encoding errors, resulting in an incorrect or malformed JsString. This could cause undefined behavior when the resulting string is used in further operations or when interfacing with other parts of the system that expect valid Latin1 encoded string.

Trait Implementations

impl<'ref_str, T> Add<T> for CommonJsStringBuilder<'ref_str>

where T: Into<Segment<'ref_str>>,

type Output = CommonJsStringBuilder<'ref_str>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> <CommonJsStringBuilder<'ref_str> as Add<T>>::Output

Performs the + operation.

impl<'ref_str, T> AddAssign<T> for CommonJsStringBuilder<'ref_str>

where T: Into<Segment<'ref_str>>,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<'a> Clone for CommonJsStringBuilder<'a>

fn clone(&self) -> CommonJsStringBuilder<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CommonJsStringBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CommonJsStringBuilder<'a>

fn default() -> CommonJsStringBuilder<'a>

Returns the “default value” for a type.