Skip to main content

HttpObjectsConfig

Struct HttpObjectsConfig 

Source
#[non_exhaustive]
pub struct HttpObjectsConfig { pub max_walk_objects: usize, pub admit_reads: bool, pub redirect_public_refs: bool, pub read_deadline: Duration, pub read_reconcile_grace: Duration, pub reachability_lag_ms: u64, pub reach_cache_entries: usize, pub max_inline_object_bytes: u64, pub http_decode_budget: u64, pub max_proof_content_bytes: u64, pub max_proof_bundle_bytes: u64, }
Expand description

Limits of opt-in HTTP object serving.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§max_walk_objects: usize

Most objects one reachability walk decides, and most ref rows scanned (including excluded refs and shard prefetch). Enumeration also has a page budget of this limit divided by the configured page size, rounded up. Exhaustion is 404 and METRIC_HTTP_REACH_CAPPED.

§admit_reads: bool

Run the Admission hook for GET and HEAD at step 11. Default off.

§redirect_public_refs: bool

Opt-in public ref redirects after all earlier checks; disabled with admission.

§read_deadline: Duration

Maximum paid transmission time from reservation creation.

§read_reconcile_grace: Duration

Time reserved for completion persistence before abandonment (default 60 s).

§reachability_lag_ms: u64

How long a reachability proof is trusted, in milliseconds: a rewind or ref deletion is visible within it (§4 reachability_lag).

§reach_cache_entries: usize

Most rows of the positive reachability cache.

§max_inline_object_bytes: u64

Largest object served from its pack entry rather than an extracted copy, at least extract_min_bytes + 10. Larger is 503.

§http_decode_budget: u64

Decode bytes one request may spend on resolution and the reachability walk; at least max_inline_object_bytes. The inline byte source has its own max_inline_object_bytes allowance on top.

§max_proof_content_bytes: u64

Maximum requested proof range content (checked before encoded size).

§max_proof_bundle_bytes: u64

Maximum encoded proof, at most SPEC-DISCLOSURE’s 64 MiB cap.

Implementations§

Source§

impl HttpObjectsConfig

Source

pub fn validate(&self, extract_min_bytes: u64) -> Result<(), ServerError>

Check the limits against the indexed configuration they run under.

§Errors

invalid_argument for a zero limit, an inline cap below extract_min_bytes + 10, or a decode budget below the inline cap.

Trait Implementations§

Source§

impl Clone for HttpObjectsConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for HttpObjectsConfig

Source§

impl Debug for HttpObjectsConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HttpObjectsConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for HttpObjectsConfig

Source§

impl PartialEq for HttpObjectsConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for HttpObjectsConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSync for T
where T: Sync + ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more