Struct cedar_policy::RequestBuilder

pub struct RequestBuilder<S> { /* private fields */ }

Available on crate feature partial-eval only.

Builder for a Request

The default for principal, action, resource, and context fields is Unknown for partial evaluation.

This feature is experimental. For more information see https://github.com/cedar-policy/rfcs/blob/main/README.md#experimental-features

Implementations

impl<S> RequestBuilder<S>

pub fn principal(self, principal: Option<EntityUid>) -> Self

Set the principal.

Note that you can create the EntityUid using .parse() on any string (via the FromStr implementation for EntityUid).

Here, passing None for principal indicates that principal does not contribute to authorization decisions (e.g., because it is not used in your policies). This is different than Unknown for partial-evaluation purposes.

pub fn action(self, action: Option<EntityUid>) -> Self

Set the action.

Note that you can create the EntityUid using .parse() on any string (via the FromStr implementation for EntityUid).

Here, passing None for action indicates that action does not contribute to authorization decisions (e.g., because it is not used in your policies). This is different than Unknown for partial-evaluation purposes.

pub fn resource(self, resource: Option<EntityUid>) -> Self

Set the resource.

Note that you can create the EntityUid using .parse() on any string (via the FromStr implementation for EntityUid).

Here, passing None for resource indicates that resource does not contribute to authorization decisions (e.g., because it is not used in your policies). This is different than Unknown for partial-evaluation purposes.

pub fn context(self, context: Context) -> Self

Set the context.

impl RequestBuilder<UnsetSchema>

pub fn schema(self, schema: &Schema) -> RequestBuilder<&Schema>

Set the schema. If present, this will be used for request validation.

pub fn build(self) -> Request

Create the Request

impl RequestBuilder<&Schema>

pub fn build(self) -> Result<Request, RequestValidationError>

Create the Request

Trait Implementations

impl<S: Debug> Debug for RequestBuilder<S>

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

Formats the value using the given formatter.

impl Default for RequestBuilder<UnsetSchema>

fn default() -> Self

Returns the “default value” for a type.