Struct ngx_str_t

#[repr(C)]
pub struct ngx_str_t {
    pub len: usize,
    pub data: *mut u8,
}

Fields

len: usize

data: *mut u8

Implementations

impl ngx_str_t

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

Returns the contents of this ngx_str_t as a byte slice.

The returned slice will not contain the optional nul terminator that ngx_str_t.data may have.

pub fn as_bytes_mut(&mut self) -> &mut [u8]

Returns the contents of this ngx_str_t as a mutable byte slice.

pub fn is_empty(&self) -> bool

Returns true if the string has a length of 0.

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

Returns the contents of this ngx_str_t a string slice (&str) if the contents are utf-8 encoded.

Returns

A string slice (&str) representing the nginx string, or else a Utf8Error.

pub const fn empty() -> ngx_str_t

Creates an empty ngx_str_t instance.

This method replaces the ngx_null_string C macro.

pub unsafe fn from_bytes(pool: *mut ngx_pool_s, src: &[u8]) -> Option<ngx_str_t>

Create an ngx_str_t instance from a byte slice.

Safety

The caller must provide a valid pointer to a memory pool.

pub unsafe fn from_str(pool: *mut ngx_pool_s, data: &str) -> ngx_str_t

Create an ngx_str_t instance from a string slice (&str).

Arguments

• pool - A pointer to the nginx memory pool (ngx_pool_t).
• data - The string slice from which to create the nginx string.

Safety

This function is marked as unsafe because it accepts a raw pointer argument. There is no way to know if pool is pointing to valid memory. The caller must provide a valid pool to avoid indeterminate behavior.

Returns

An ngx_str_t instance representing the given string slice.

pub fn split_at(&self, mid: usize) -> Option<(ngx_str_t, ngx_str_t)>

Divides one ngx_str_t into two at an index.

Safety

The results will reference the original string; be wary of the ownership and lifetime.

pub fn strip_prefix(&self, prefix: impl AsRef<[u8]>) -> Option<ngx_str_t>

Returns an ngx_str_t with the prefix removed.

If the string starts with the byte sequence prefix, returns the substring after the prefix, wrapped in Some. The resulting substring can be empty.

Safety

The result will reference the original string; be wary of the ownership and lifetime.

The method is not marked as unsafe as everything it does is possible via safe interfaces.

pub fn strip_suffix(&self, suffix: impl AsRef<[u8]>) -> Option<ngx_str_t>

Returns an ngx_str_t with the suffix removed.

If the string ends with the byte sequence suffix, returns the substring before the suffix, wrapped in Some. The resulting substring can be empty.

Safety

The result will reference the original string; be wary of the ownership and lifetime.

The method is not marked as unsafe as everything it does is possible via safe interfaces.

Trait Implementations

impl AsMut<[u8]> for ngx_str_t

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

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

impl AsRef<[u8]> for ngx_str_t

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

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

impl Clone for ngx_str_t

fn clone(&self) -> ngx_str_t

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ngx_str_t

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

Formats the value using the given formatter.

impl Default for ngx_str_t

fn default() -> ngx_str_t

Returns the “default value” for a type.

impl Display for ngx_str_t

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

Formats the value using the given formatter.

impl From<ngx_str_t> for &[u8]

fn from(s: ngx_str_t) -> &[u8]

Converts to this type from the input type.

impl Hash for ngx_str_t

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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 Ord for ngx_str_t

fn cmp(&self, other: &ngx_str_t) -> 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> PartialEq<&'a NgxStr> for ngx_str_t

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> PartialEq<NgxStr> for ngx_str_t

fn eq(&self, other: &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 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<'a> PartialEq<ngx_str_t> for &'a NgxStr

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> PartialEq<ngx_str_t> for NgxStr

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> 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 PartialEq for ngx_str_t

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> PartialOrd<&'a NgxStr> for ngx_str_t

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> PartialOrd<NgxStr> for ngx_str_t

fn partial_cmp(&self, other: &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 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<'a> PartialOrd<ngx_str_t> for &'a NgxStr

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<'a> PartialOrd<ngx_str_t> for NgxStr

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<'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 PartialOrd for ngx_str_t

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 TryFrom<ngx_str_t> for &str

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(s: ngx_str_t) -> Result<&str, <&str as TryFrom<ngx_str_t>>::Error>

Performs the conversion.

impl Copy for ngx_str_t

impl Eq for ngx_str_t