Struct vnd_siren::entity::EntityBuilder

pub struct EntityBuilder { /* private fields */ }

A builder of Entities.

Implementations

impl EntityBuilder

pub fn action(self, action: impl Into<Action>) -> Self

Adds and Action to the Entity.

Examples

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

pub fn actions(self, actions: Vec<impl Into<Action>>) -> Self

Adds a list of Actions to the Entity.

Examples

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

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

Add a class to the Entity

Examples

let entity: Entity = Entity::builder()
    .class("item").into();
 
assert_eq!(&Some(vec!["item".to_string()]), entity.classes());

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

Add a vector of classes to the Entity

Examples

let entity: Entity = Entity::builder()
    .classes(vec!["item"]).into();
 
assert_eq!(&Some(vec!["item".to_string()]), entity.classes());

pub fn entity(self, entity: impl Into<Entity>) -> Self

Add an Entity to the Entity.

Examples

let entity: Entity = Entity::builder()
    .entity(Entity::builder()).into();
 
assert_eq!(&Some(vec![Box::new(Entity::builder().into())]), entity.entities());

pub fn entities(self, entities: Vec<impl Into<Entity>>) -> Self

Add a vector of Entities to the Entity.

Examples

let entity: Entity = Entity::builder()
    .entities(vec![Entity::builder()]).into();
 
assert_eq!(&Some(vec![Box::new(Entity::builder().into())]), entity.entities());

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

Set the Entity’s href.

Examples

let entity: Entity = Entity::builder()
    .href("http://api.x.io/orders/42/items").into();
 
assert_eq!(&Some("http://api.x.io/orders/42/items".to_string()), entity.href());

pub fn link(self, link: impl Into<Link>) -> Self

Add a Link to the Entity.

Examples

let entity: Entity = Entity::builder()
    .link(Link::builder(vec!["self"], "http://api.x.io/customers/pj123"))
    .into();
 
assert_eq!(
    &Some(vec![
        Link::builder(vec!["self"], "http://api.x.io/customers/pj123").into()
    ]),
    entity.links(),
);

pub fn links(self, links: Vec<impl Into<Link>>) -> Self

Add a vector of Links to the Entity.

Examples

let entity: Entity = Entity::builder()
    .links(vec![
        Link::builder(vec!["self"], "http://api.x.io/customers/pj123")
    ]).into();
 
assert_eq!(
    &Some(vec![
        Link::builder(vec!["self"], "http://api.x.io/customers/pj123").into()
    ]),
    entity.links(),
);

pub fn property(self, key: impl Into<String>, value: impl Into<Value>) -> Self

Add a Property to the Entity.

Examples

let entity: Entity = Entity::builder()
    .property("customerId", "pj123")
    .property("name", "Peter Joseph")
    .into();

pub fn properties(self, properties: Vec<impl Into<Property>>) -> Self

Add a vector of Properties to the Entity.

Examples

let entity: Entity = Entity::builder()
    .properties(vec![
        Property::new("customerId", "pj123"),
        Property::new("name", "Peter Joseph"),
    ]).into();

let entity: Entity = Entity::builder()
    .properties(vec![
        ("customerId", "pj123"),
        ("name", "Peter Joseph"),
    ]).into();

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

Add a vector of Rels for the Entity.

Examples

let entity: Entity = Entity::builder()
    .rel(vec!["http://x.io/rels/customer"]).into();
 
assert_eq!(&Some(vec!["http://x.io/rels/customer".to_string()]), entity.rel());

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

Set the Entity’s title.

Examples

let entity: Entity = Entity::builder()
    .title("example").into();
 
assert_eq!(&Some("example".to_string()), entity.title());

Trait Implementations

impl Clone for EntityBuilder

fn clone(&self) -> EntityBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityBuilder

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

Formats the value using the given formatter.

impl From<EntityBuilder> for Entity

fn from(builder: EntityBuilder) -> Entity

Converts to this type from the input type.

impl PartialEq<EntityBuilder> for EntityBuilder

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