Struct Settings 

pub struct Settings { /* private fields */ }

Available on crate features http and std only.

An ordered collection of HTTP/3 settings (RFC 9114 §7.2.4).

Order is preserved so that a caller reproducing a specific wire image (a fingerprint profile, for example) can control it. Duplicate identifiers — known, unknown or reserved — are rejected, and the HTTP/2-forbidden identifiers are rejected, both as required by RFC 9114 §7.2.4.1.

Implementations

impl Settings

pub fn new() -> Settings

An empty settings set.

pub fn entries(&self) -> &[Setting]

The settings in wire order.

pub fn len(&self) -> usize

The number of settings.

pub fn is_empty(&self) -> bool

Whether there are no settings.

pub fn get(&self, id: SettingId) -> Option<u64>

The value of a setting, if present.

pub fn qpack_max_table_capacity(&self) -> u64

SETTINGS_QPACK_MAX_TABLE_CAPACITY, defaulting to 0 (RFC 9204 §5).

pub fn qpack_blocked_streams(&self) -> u64

SETTINGS_QPACK_BLOCKED_STREAMS, defaulting to 0 (RFC 9204 §5).

pub fn max_field_section_size(&self) -> Option<u64>

SETTINGS_MAX_FIELD_SECTION_SIZE, defaulting to unlimited (None; RFC 9114 §7.2.4.1).

pub fn insert(&mut self, setting: Setting) -> Result<(), SettingsError>

Append a setting, rejecting duplicates and HTTP/2-forbidden identifiers.

pub fn set(&mut self, id: SettingId, value: u64) -> Result<(), SettingsError>

Append a setting by identifier and value; see Settings::insert.

pub fn encode_payload<B>(&self, dst: &mut B) -> Option<()>

where B: BufMut,

Encode the settings payload (the entries, without the frame header) into dst.

Returns None without writing if any identifier or value exceeds the variable-length integer range.

pub fn payload_len(&self) -> Option<usize>

The encoded byte length of the settings payload, or None if a value is out of range.

pub fn decode(src: &[u8]) -> Result<Settings, SettingsError>

Decode a complete SETTINGS payload from src, using DEFAULT_MAX_SETTINGS_ENTRIES.

src must contain exactly the frame payload; the caller (which owns framing) is responsible for having buffered len bytes and for bounding len before doing so.

pub fn decode_with_limit( src: &[u8], max_entries: usize, ) -> Result<Settings, SettingsError>

Decode a complete SETTINGS payload, accepting at most max_entries entries.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Settings

Returns the “default value” for a type.

impl Eq for Settings

impl PartialEq for Settings

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Settings