Struct NgxString

pub struct NgxString<A>(/* private fields */)
where
    A: Allocator + Clone;

Owned byte string type with Allocator support.

Inspired by bstr and unstable feature(bstr), with two important differences:

• Allocator always have to be specified,
• any allocating methods are failible and require explicit handling of the result.

Implementations

impl<A> NgxString<A>

where A: Allocator + Clone,

pub fn new_in(alloc: A) -> Self

Constructs a new, empty NgxString<A>.

No allocations will be made until data is added to the string.

pub fn try_from_bytes_in( bytes: impl AsRef<[u8]>, alloc: A, ) -> Result<Self, TryReserveError>

Tries to construct a new NgxString<A> from a byte slice.

pub fn allocator(&self) -> &A

Returns a reference to the underlying allocator

pub fn capacity(&self) -> usize

Returns this NgxString’s capacity, in bytes.

pub fn is_empty(&self) -> bool

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

pub fn len(&self) -> usize

Return this NgxString’s length, in bytes.

pub fn append_within_capacity( &mut self, other: impl AsRef<[u8]>, ) -> Result<(), usize>

Appends bytes if there is sufficient spare capacity.

Returns the number of remaining bytes on overflow.

pub fn try_append( &mut self, other: impl AsRef<[u8]>, ) -> Result<(), TryReserveError>

Tries to append the bytes to the NgxString.

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

Tries to reserve capacity for at least additional more bytes.

pub fn try_reserve_exact( &mut self, additional: usize, ) -> Result<(), TryReserveError>

Tries to reserve the minimum capacity for at least additional more bytes.

pub unsafe fn from_raw_parts( ptr: *mut u8, length: usize, capacity: usize, alloc: A, ) -> Self

Creates NgxString directly from a pointer, a capacity, a length and an allocator.

Safety

See Vec::from_raw_parts_in

pub fn into_raw_parts(self) -> (*mut u8, usize, usize, A)

Splits the NgxString into its raw components.

The caller becomes responsible for the memory previously managed by this NgxString.

Methods from Deref<Target = NgxStr>

pub fn as_bytes(&self) -> &[u8]

Access the NgxStr as a byte slice.

pub fn to_str(&self) -> Result<&str, Utf8Error>

Yields a &str slice if the NgxStr contains valid UTF-8.

pub fn to_string_lossy(&self) -> Cow<'_, str>

Converts an NgxStr into a Cow<str>, replacing invalid UTF-8 sequences.

See String::from_utf8_lossy.

pub fn is_empty(&self) -> bool

Returns true if the NgxStr is empty, otherwise false.

Trait Implementations

impl<A> AsMut<[u8]> for NgxString<A>

where A: Allocator + Clone,

fn as_mut(&mut self) -> &mut [u8]

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

impl<A> AsMut<NgxStr> for NgxString<A>

where A: Allocator + Clone,

fn as_mut(&mut self) -> &mut NgxStr

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

impl<A> AsRef<[u8]> for NgxString<A>

where A: Allocator + Clone,

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

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

impl<A> AsRef<NgxStr> for NgxString<A>

where A: Allocator + Clone,

fn as_ref(&self) -> &NgxStr

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

impl<A> Borrow<[u8]> for NgxString<A>

where A: Allocator + Clone,

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl<A> Borrow<NgxStr> for NgxString<A>

where A: Allocator + Clone,

fn borrow(&self) -> &NgxStr

Immutably borrows from an owned value.

impl<A> Clone for NgxString<A>

where A: Allocator + Clone + Clone,

fn clone(&self) -> NgxString<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A> Debug for NgxString<A>

where A: Allocator + Clone,

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

Formats the value using the given formatter.

impl<A> Deref for NgxString<A>

where A: Allocator + Clone,

type Target = NgxStr

The resulting type after dereferencing.

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

Dereferences the value.

impl<A> DerefMut for NgxString<A>

where A: Allocator + Clone,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<A> Display for NgxString<A>

where A: Allocator + Clone,

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

Formats the value using the given formatter.

impl<A> Hash for NgxString<A>

where A: Allocator + Clone,

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> Ord for NgxString<A>

where A: Allocator + Clone,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a, A: Allocator + Clone> PartialEq<&'a [u8]> for NgxString<A>

fn eq(&self, other: &&'a [u8]) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: Allocator + Clone, const N: usize> PartialEq<&'a [u8; N]> for NgxString<A>

fn eq(&self, other: &&'a [u8; N]) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: Allocator + Clone> PartialEq<&'a NgxStr> for NgxString<A>

fn eq(&self, other: &&'a NgxStr) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: Allocator + Clone> PartialEq<NgxString<A>> for &'a [u8]

fn eq(&self, other: &NgxString<A>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: Allocator + Clone, const N: usize> PartialEq<NgxString<A>> for &'a [u8; N]

fn eq(&self, other: &NgxString<A>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: Allocator + Clone> PartialEq<NgxString<A>> for &'a NgxStr

fn eq(&self, other: &NgxString<A>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: Allocator + Clone> PartialEq<NgxString<A>> for ngx_str_t

fn eq(&self, other: &NgxString<A>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A1, A2> PartialEq<NgxString<A2>> for NgxString<A1>

where A1: Allocator + Clone, A2: Allocator + Clone,

fn eq(&self, other: &NgxString<A2>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: Allocator + Clone> PartialEq<ngx_str_t> for NgxString<A>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: Allocator + Clone> PartialOrd<&'a [u8]> for NgxString<A>

fn partial_cmp(&self, other: &&'a [u8]) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, A: Allocator + Clone, const N: usize> PartialOrd<&'a [u8; N]> for NgxString<A>

fn partial_cmp(&self, other: &&'a [u8; N]) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, A: Allocator + Clone> PartialOrd<&'a NgxStr> for NgxString<A>

fn partial_cmp(&self, other: &&'a NgxStr) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, A: Allocator + Clone> PartialOrd<NgxString<A>> for &'a [u8]

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, A: Allocator + Clone, const N: usize> PartialOrd<NgxString<A>> for &'a [u8; N]

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, A: Allocator + Clone> PartialOrd<NgxString<A>> for &'a NgxStr

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, A: Allocator + Clone> PartialOrd<NgxString<A>> for ngx_str_t

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<A1, A2> PartialOrd<NgxString<A2>> for NgxString<A1>

where A1: Allocator + Clone, A2: Allocator + Clone,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, A: Allocator + Clone> PartialOrd<ngx_str_t> for NgxString<A>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<OA: Allocator + Clone> TryCloneIn for NgxString<OA>

type Target<A: Allocator + Clone> = NgxString<A>

Target type, generic over an allocator.

fn try_clone_in<A: Allocator + Clone>( &self, alloc: A, ) -> Result<Self::Target<A>, AllocError>

Attempts to copy the value using alloc as an underlying Allocator.

impl<A> Write for NgxString<A>

where A: Allocator + Clone,

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl<A> Eq for NgxString<A>

where A: Allocator + Clone,