Struct CodeUnitString 

pub struct CodeUnitString { /* private fields */ }

An exact sequence of UTF-16 code units.

Unlike String, this value admits lone surrogates. Conversion to scalar Unicode is therefore explicit and checked.

Implementations

impl CodeUnitString

pub fn from_scalar(text: &str) -> Self

Encode scalar Unicode text as UTF-16 code units.

pub fn try_from_code_units(units: Vec<u16>) -> Result<Self, CodeUnitStringError>

Preserve an exact sequence, rejecting an unrepresentable allocation.

pub fn from_code_units(units: Vec<u16>) -> Self

Preserve an exact sequence including lone surrogates.

A Rust Vec<u16> that already exists necessarily satisfies the allocation limit, so this compatibility constructor is infallible.

pub fn as_code_units(&self) -> &[u16]

Borrow all exact code units.

pub fn len(&self) -> usize

Return the length in code units.

pub fn is_empty(&self) -> bool

Whether the value has no code units.

pub fn code_unit_at(&self, offset: CodeUnitOffset) -> Option<u16>

Index one code unit.

pub fn slice(&self, range: CodeUnitRange) -> Self

Slice by a code-unit range, clamping both bounds.

pub fn code_units(&self) -> impl ExactSizeIterator<Item = u16> + '_

Iterate exact code units (the indexing face).

pub fn iter_code_points(&self) -> CodePointIter<'_>

Iterate chunks consisting of one surrogate pair or one unpaired unit.

pub fn to_scalar(&self) -> Result<String, CodeUnitStringError>

Convert well-formed UTF-16 to scalar Unicode text.

pub fn code_unit_offset( &self, scalar: ScalarOffset, ) -> Result<CodeUnitOffset, OffsetConversionError>

Convert a bounded scalar offset to its code-unit offset.

pub fn scalar_offset( &self, code_unit: CodeUnitOffset, ) -> Result<ScalarOffset, OffsetConversionError>

Convert a bounded code-unit offset at a scalar boundary.

Trait Implementations

impl AsRef<[u16]> for CodeUnitString

fn as_ref(&self) -> &[u16]

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

impl Clone for CodeUnitString

fn clone(&self) -> CodeUnitString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeUnitString

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

Formats the value using the given formatter.

impl Default for CodeUnitString

fn default() -> CodeUnitString

Returns the “default value” for a type.

impl Eq for CodeUnitString

impl Hash for CodeUnitString

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 Object for CodeUnitString

fn display(&self, _cx: &mut Cx) -> Result<String>

Render the object as a human-readable display string.

fn as_any(&self) -> &dyn Any

Expose the object for Rust downcasting.

fn header(&self) -> &ObjectHeader

Identity and trust header for the object; defaults to the shared anonymous header.

fn op(&self, _key: &OpKey) -> Option<&dyn Op>

Resolve the operation registered under key, if any.

fn claims( &self, _cx: &mut Cx, _pattern: &ClaimPattern, _sink: &mut dyn ClaimSink, ) -> Result<(), Error>

Emit the object’s claims matching pattern into sink.

fn snapshot(&self, _cx: &mut Cx) -> Result<Option<Datum>, Error>

Optional content-addressable snapshot of the object’s state.

impl ObjectCompat for CodeUnitString

fn as_expr(&self, _cx: &mut Cx) -> Result<Expr>

Expression form of the object; defaults to an opaque extension node.

fn as_table(&self, cx: &mut Cx) -> Result<Value>

Project the object into a table value; the default exposes its display.

fn as_object_encoder(&self) -> Option<&dyn ObjectEncode>

Object-encoder view, if the object encodes other objects.

fn class(&self, cx: &mut Cx) -> Result<Value, Error>

Class object this value belongs to; defaults to nil.

fn as_callable(&self) -> Option<&dyn Callable>

Callable view, if the object can be invoked.

fn as_class(&self) -> Option<&dyn Class>

Class view, if the object is a class.

fn as_shape(&self) -> Option<&dyn Shape>

Shape view, if the object is a shape.

fn as_read_constructor(&self) -> Option<&dyn ReadConstructor>

Read-constructor view, if the object decodes data forms.

fn as_number_domain(&self) -> Option<&(dyn NumberDomain + 'static)>

Number-domain view, if the object is a number domain.

fn as_number_value(&self) -> Option<&dyn NumberValue>

Number-value view, if the object is a domain number.

fn as_eval_fabric(&self) -> Option<&dyn EvalFabric>

Eval-fabric view, if the object is a distributed eval surface.

fn as_stream(&self) -> Option<&dyn Stream>

Stream view, if the object is a stream.

fn as_sequence(&self) -> Option<&dyn Sequence>

Sequence view, if the object is a sequence.

fn as_thunk(&self) -> Option<&dyn Thunk>

Thunk view, if the object is a deferred computation.

fn as_list(&self) -> Option<&(dyn ListValue + 'static)>

List view, if the object is a list value.

fn as_table_impl(&self) -> Option<&(dyn Table + 'static)>

Table-implementation view, if the object is a table.

fn as_dir(&self) -> Option<&(dyn Dir + 'static)>

Directory view, if the object is a directory.

fn truth(&self, _cx: &mut Cx) -> Result<bool, Error>

Truthiness of the object; defaults to true.

fn publish_shape_satisfaction_claims( &self, _cx: &mut Cx, _shape: &Ref, ) -> Result<bool, Error>

Publish claims asserting that the object satisfies shape; returns whether any were published.

impl ObjectEncode for CodeUnitString

fn object_encoding(&self, _cx: &mut Cx) -> Result<ObjectEncoding>

Returns the ObjectEncoding this object should be rendered as.

impl PartialEq for CodeUnitString

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CodeUnitString