Skip to main content

EntitiesDescriptor

Struct EntitiesDescriptor 

Source
pub struct EntitiesDescriptor {
    pub name: Option<String>,
    pub valid_until: Option<SystemTime>,
    pub entities: Vec<MetadataEntry>,
}
Expand description

Parsed <md:EntitiesDescriptor> (or a single <md:EntityDescriptor> promoted to an aggregate with one entry, for caller convenience).

Fields§

§name: Option<String>§valid_until: Option<SystemTime>§entities: Vec<MetadataEntry>

Implementations§

Source§

impl EntitiesDescriptor

Source

pub fn from_metadata_xml(xml: &[u8]) -> Result<Self, Error>

Parse a federation aggregate or a single-entity metadata document.

Uses an aggregate-sized node ceiling (XmlLimits::aggregate) so real InCommon / eduGAIN aggregates — which exceed the default ~100k-node limit — parse successfully. To parse under tighter (or looser) limits, use from_metadata_xml_with_limits.

Source

pub fn from_metadata_xml_with_limits( xml: &[u8], limits: XmlLimits, ) -> Result<Self, Error>

Parse a federation aggregate or single-entity metadata document under caller-supplied resource limits.

from_metadata_xml calls this with XmlLimits::aggregate; pass a tighter XmlLimits when the input is known to be small and you want a smaller worst-case allocation bound.

Source

pub fn by_entity_id(&self, entity_id: &str) -> Option<&MetadataEntry>

Find an entry by its entityID, regardless of role. Returns the first match in document order.

This is a linear scan over entities. For repeated lookups against a large aggregate (InCommon publishes thousands of entities), build an index once with index_by_entity_id and query that instead.

Source

pub fn index_by_entity_id(&self) -> HashMap<&str, &MetadataEntry>

Build a HashMap from entityID to entry for O(1) repeated lookups.

Federation aggregates with thousands of entities make the linear by_entity_id / find_idp / find_sp scans expensive when a caller resolves many entityIDs; constructing this index once amortizes the cost. Other entries (no entityID) are skipped. When a duplicate entityID appears the first entry in document order wins, matching the linear accessors.

Source

pub fn find_idp(&self, entity_id: &str) -> Option<&IdpDescriptor>

Find an IdP entity by entity ID.

Source

pub fn find_sp(&self, entity_id: &str) -> Option<&SpDescriptor>

Find an SP entity by entity ID.

Source

pub fn iter_idps(&self) -> impl Iterator<Item = &IdpDescriptor>

Iterate over all IdP descriptors (including the IdP half of Dual entries).

Source

pub fn iter_sps(&self) -> impl Iterator<Item = &SpDescriptor>

Iterate over all SP descriptors (including the SP half of Dual entries).

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> PolicyExt for T
where T: ?Sized,

Source§

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

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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