Struct AuxOptions

#[repr(C)]
pub struct AuxOptions<'str, const N: usize> {
    pub options: [*const c_char; N],
    /* private fields */
}

List of string options to be used with Thread::check_option.

The generic const N: usize specifies the static number of entries; 'str indicates the lifetime for every entry, which are C strings.

Fields

options: [*const c_char; N]

Implementations

impl<'str, const N: usize> AuxOptions<'str, N>

pub const fn new(items: [&'str CStr; N]) -> Self

Construct an instance of AuxOptions with a static list of options.

Examples found in repository

examples/string_enum.rs (lines 20-25)

	const OPTIONS: &'static LuaAuxOptions<'static, 4> = &LuaAuxOptions::new([
		c"udp",
		c"tcp",
		c"unix udp",
		c"unix tcp",
	]);

pub const fn count() -> usize

Return the number of options that this list has.

pub const fn as_ptr(&self) -> *const *const c_char

Return a pointer to this structure to be used with C.

pub const fn as_str_ptr_slice(&self) -> &[*const c_char]

Return a slice of *const c_chars that represent the string options contained within the structure.

Trait Implementations

impl<'str, const N: usize> Clone for AuxOptions<'str, N>

fn clone(&self) -> AuxOptions<'str, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'str, const N: usize> Debug for AuxOptions<'str, N>

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

Formats the value using the given formatter.

impl<'str, const N: usize> Ord for AuxOptions<'str, N>

fn cmp(&self, other: &AuxOptions<'str, N>) -> 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<'str, const N: usize> PartialEq for AuxOptions<'str, N>

fn eq(&self, other: &AuxOptions<'str, 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<'str, const N: usize> PartialOrd for AuxOptions<'str, N>

fn partial_cmp(&self, other: &AuxOptions<'str, 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<'str, const N: usize> Copy for AuxOptions<'str, N>

impl<'str, const N: usize> Eq for AuxOptions<'str, N>

impl<'str, const N: usize> StructuralPartialEq for AuxOptions<'str, N>