Struct vnd_siren::action::ActionBuilder

pub struct ActionBuilder {
    pub class: Option<Vec<String>>,
    pub fields: Option<Vec<Field>>,
    pub name: String,
    pub href: String,
    pub method: Option<Method>,
    pub title: Option<String>,
    pub typ: Option<String>,
}

A builder of Actions

Fields

class: Option<Vec<String>>

Describes the nature of an action based on the current representation. Possible values are implementation-dependent and should be documented.

fields: Option<Vec<Field>>

A collection of fields, expressed as an array of objects in JSON Siren such as { "fields" : [{ ... }] }.

name: String

A string that identifies the action to be performed. Action names MUST be unique within the set of actions for an entity. The behavior of clients when parsing a Siren document that violates this constraint is undefined.

href: String

The URI of the action.

method: Option<Method>

An enumerated attribute mapping to a protocol method. For HTTP, these values may be GET, PUT, POST, DELETE, or PATCH. As new methods are introduced, this list can be extended. If this attribute is omitted, GET should be assumed.

title: Option<String>

Descriptive text about the action.

typ: Option<String>

The encoding type for the request. When omitted and the fields attribute exists, the default value is application/x-www-form-urlencoded.

Implementations

impl ActionBuilder

pub fn class(self, class: impl Into<String>) -> Self

Add a Class to the Action.

Examples

let action: Action = Action::builder("add-item", "http://api.x.io/orders/42/items")
    .class("item").into();
 
assert_eq!(&Some(vec!["item".to_string()]), action.classes());

pub fn classes(self, classes: Vec<impl Into<String>>) -> Self

Add a vector of Classes to the Action.

Examples

let action: Action = Action::builder("add-item", "http://api.x.io/orders/42/items")
    .classes(vec!["item"]).into();
 
assert_eq!(&Some(vec!["item".to_string()]), action.classes());

pub fn field(self, field: impl Into<Field>) -> Self

Add a Field to the Action.

Examples

let action: Action = Action::builder("add-item", "http://api.x.io/orders/42/items")
    .field(Field::builder("orderNumber").typ("hidden").value("42"))
    .field(Field::builder("productCode").typ("text"))
    .field(Field::builder("quantity").typ("number"))
    .into();
 
assert_eq!(
    &Some(vec![
        Field::builder("orderNumber").typ("hidden").value("42").into(),
        Field::builder("productCode").typ("text").into(),
        Field::builder("quantity").typ("number").into(),
    ]),
    action.fields(),
);

pub fn fields(self, fields: Vec<impl Into<Field>>) -> Self

Add a vector of Fields to the Action.

Examples

let action: Action = Action::builder("add-item", "http://api.x.io/orders/42/items")
    .fields(vec![
        Field::builder("orderNumber").typ("hidden").value("42"),
        Field::builder("productCode").typ("text"),
        Field::builder("quantity").typ("number"),
    ]).into();
 
assert_eq!(
    &Some(vec![
        Field::builder("orderNumber").typ("hidden").value("42").into(),
        Field::builder("productCode").typ("text").into(),
        Field::builder("quantity").typ("number").into(),
    ]),
    action.fields(),
);

pub fn method(self, method: Method) -> Self

Set the Method of the Action.

Examples

let action: Action = Action::builder("add-item", "http://api.x.io/orders/42/items")
    .method(Method::Post).into();
 
assert_eq!(&Some(Method::Post), action.method());

pub fn title(self, title: impl Into<String>) -> Self

Set the title of the Action.

Examples

let action: Action = Action::builder("add-item", "http://api.x.io/orders/42/items")
    .title("Add Item").into();
 
assert_eq!(&Some("Add Item".to_string()), action.title());

pub fn typ(self, typ: impl Into<String>) -> Self

Set the Action’s type.

Examples

let action: Action = Action::builder("add-item", "http://api.x.io/orders/42/items")
    .typ("application/x-www-form-urlencoded")
    .into();
 
assert_eq!(&Some("application/x-www-form-urlencoded".to_string()), action.typ());

Trait Implementations

impl Clone for ActionBuilder

fn clone(&self) -> ActionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActionBuilder

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

Formats the value using the given formatter.

impl From<ActionBuilder> for Action

fn from(builder: ActionBuilder) -> Action

Converts to this type from the input type.

impl PartialEq<ActionBuilder> for ActionBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ActionBuilder