Skip to main content

WebSocketReviewPolicy

Struct WebSocketReviewPolicy 

Source
pub struct WebSocketReviewPolicy { /* private fields */ }
Expand description

Strict, bounded declaration for one isolated WebSocket connection.

Implementations§

Source§

impl WebSocketReviewPolicy

Source

pub fn parse_json( application_target: &Url, source: &[u8], ) -> Result<Self, WebSocketReviewPolicyError>

Parses strict JSON and validates it as a narrowing child of the exact host, effective port, and application-path scope of application_target.

The two required true values are retained only as operator assertions. Parsing does not independently verify authorization or message side effects.

Source

pub const fn schema(&self) -> &'static str

Returns the accepted policy schema.

Source

pub fn policy_reference(&self) -> &str

Returns the stable reference for the operator-versioned policy identity.

Source

pub fn application_reference(&self) -> &str

Returns the stable reference for the application authority scope.

Source

pub fn endpoint_reference(&self) -> &str

Returns the stable reference for the exact WebSocket endpoint.

Source

pub fn message_count(&self) -> usize

Returns the number of ordered outbound declarations.

Source

pub fn messages( &self, ) -> impl ExactSizeIterator<Item = WebSocketReviewMessageRef<'_>>

Returns value-free metadata for the ordered message declarations.

Source

pub const fn origin_mode(&self) -> WebSocketOriginMode

Returns the selected Origin-header behavior.

Source

pub const fn has_subprotocol(&self) -> bool

Reports whether one validated subprotocol token is present without exposing the operator-authored token.

Source

pub const fn target_authorized(&self) -> bool

Returns the required, unverified operator authorization assertion.

Source

pub const fn messages_read_only_acknowledged(&self) -> bool

Returns the required, unverified read-only-message acknowledgement.

Source

pub const fn message_content_is_non_secret(&self) -> bool

Returns the required operator assertion that message bodies are not secrets.

Source

pub const fn compression_enabled(&self) -> bool

V1 always disables WebSocket extension negotiation.

Source

pub const fn reconnect_enabled(&self) -> bool

V1 always owns exactly one connection attempt and never reconnects.

Source

pub const fn limits(&self) -> WebSocketReviewLimits

Returns all validated finite runtime ceilings.

Source

pub const fn max_inbound_message_bytes(&self) -> u64

Maximum bytes in one inbound application message.

Source

pub const fn max_outbound_message_bytes(&self) -> u64

Maximum bytes in one outbound application message.

Source

pub const fn max_messages(&self) -> u16

Shared directional application-message count ceiling.

Source

pub const fn max_control_frames(&self) -> u16

Connection-wide control-frame count ceiling.

Source

pub const fn max_wall_time_ms(&self) -> u64

Wall-clock ceiling in whole milliseconds.

Trait Implementations§

Source§

impl Clone for WebSocketReviewPolicy

Source§

fn clone(&self) -> WebSocketReviewPolicy

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 Debug for WebSocketReviewPolicy

Source§

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

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

impl Eq for WebSocketReviewPolicy

Source§

impl PartialEq for WebSocketReviewPolicy

Source§

fn eq(&self, other: &WebSocketReviewPolicy) -> 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 WebSocketReviewPolicy

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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
§

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

§

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

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

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

§

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

Compare self to key and return true if they are equal.
§

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

§

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.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

§

impl<T> Instrument for T

§

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

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

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.

§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> WithSubscriber for T

§

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
§

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

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