Struct ClaimPath 

pub struct ClaimPath(/* private fields */);

Available on crate feature vc only.

A path into a JSON payload: a non-empty list of property names, array indexes and null (every element).

SD-JWT VC §5.6.1 uses it as the path of claim metadata, where it names the claim as if everything were disclosed; OID4VP §7 defines the same construct as the claims path pointer of DCQL claims[].path, for every JSON-based credential format (jwt_vc_json and dc+sd-jwt alike). ISO mdoc paths, which OID4VP §7 defines differently, are out of scope.

Examples

use identity_kit::vc::ClaimPath;
use serde_json::json;

// SD-JWT VC §5.6.1.1 and OID4VP §7.
let credential = json!({
  "name": "Arthur Dent",
  "address": { "street_address": "42 Market Street", "city": "Milliways" },
  "degrees": [
    { "type": "Bachelor of Science", "university": "University of Betelgeuse" },
    { "type": "Master of Science", "university": "University of Betelgeuse" }
  ],
  "nationalities": ["British", "Betelgeusian"]
});
let path: ClaimPath = serde_json::from_value(json!(["degrees", null, "type"]))?;
assert_eq!(
    path.select(&credential)?,
    vec![&json!("Bachelor of Science"), &json!("Master of Science")]
);
let street = ClaimPath::new(["address", "street_address"]);
assert_eq!(street.select(&credential)?, vec![&json!("42 Market Street")]);
assert!(ClaimPath::new(["name", "first"]).select(&credential).is_err());

Implementations

impl ClaimPath

pub fn new<I, C>(components: I) -> Self

where I: IntoIterator<Item = C>, C: Into<PathComponent>,

The path through components: &str names, usize indexes and () for every element.

pub fn root() -> Self

The empty path: the payload itself.

pub fn components(&self) -> &[PathComponent]

The components.

pub fn is_empty(&self) -> bool

Whether the path has no components.

pub fn is_concrete(&self) -> bool

Whether every component names one element: no null.

pub fn matches(&self, path: &ClaimPath) -> bool

Whether this path, which may contain null components, covers the concrete path.

pub fn is_prefix_of(&self, path: &ClaimPath) -> bool

Whether this path, which may contain null components, covers the concrete path or one of its ancestors.

pub fn join(&self, component: impl Into<PathComponent>) -> Self

This path with component appended.

pub fn select<'a>( &self, root: &'a Value, ) -> Result<Vec<&'a Value>, ClaimPathError>

The values the path selects in root, per the processing rules of SD-JWT VC §5.6.1.2: empty when a name or an index does not exist.

Errors

ClaimPathError when a component meets a value of the wrong kind: a name against a non-object, an index or null against a non-array.

pub fn resolve(&self, root: &Value) -> Result<Vec<ClaimPath>, ClaimPathError>

The concrete paths (every null resolved to the indexes it selects) at which the path selects a value in root, in document order.

Errors

As select.

Trait Implementations

impl Clone for ClaimPath

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClaimPath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClaimPath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ClaimPath

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

Formats the value using the given formatter.

impl Eq for ClaimPath

impl From<Vec<PathComponent>> for ClaimPath

fn from(components: Vec<PathComponent>) -> Self

Converts to this type from the input type.

impl<C: Into<PathComponent>, const N: usize> From<[C; N]> for ClaimPath

fn from(components: [C; N]) -> Self

Converts to this type from the input type.

impl<C: Into<PathComponent>> FromIterator<C> for ClaimPath

fn from_iter<I: IntoIterator<Item = C>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for ClaimPath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ClaimPath

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

Equality operator ==.

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

Inequality operator !=.

impl PartialSchema for ClaimPath

Available on crate feature utoipa only.

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl Serialize for ClaimPath

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClaimPath

impl ToSchema for ClaimPath

Available on crate feature utoipa only.

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.