Struct JsonUiView 

pub struct JsonUiView {
    pub schema: String,
    pub layout: Option<String>,
    pub title: Option<String>,
    pub data: Value,
    pub errors: Option<HashMap<String, Vec<String>>>,
    pub components: Vec<ComponentNode>,
}

Top-level JSON-UI view container.

Every JSON-UI response is a JsonUiView containing a component tree. The $schema field identifies the schema version for compatibility.

Example

use ferro_json_ui::JsonUiView;

let view = JsonUiView::new()
    .title("Dashboard")
    .layout("app");

let json = view.to_json().unwrap();
assert!(json.contains("ferro-json-ui/v1"));

Fields

schema: String

layout: Option<String>

title: Option<String>

data: Value

errors: Option<HashMap<String, Vec<String>>>

components: Vec<ComponentNode>

Implementations

impl JsonUiView

pub fn new() -> Self

Create a new view with the current schema version and empty components.

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

Set the view title.

pub fn data(self, data: Value) -> Self

Set the view data payload.

pub fn errors(self, errors: HashMap<String, Vec<String>>) -> Self

Set the validation errors map.

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

Set the layout name.

pub fn component(self, node: ComponentNode) -> Self

Add a single component to the view.

pub fn components(self, nodes: Vec<ComponentNode>) -> Self

Set all components at once, replacing any existing.

pub fn from_json(json: &str) -> Result<Self, Error>

Parse a view from a JSON string.

pub fn to_json(&self) -> Result<String, Error>

Serialize the view to a compact JSON string.

pub fn to_json_pretty(&self) -> Result<String, Error>

Serialize the view to a pretty-printed JSON string.

Trait Implementations

impl Clone for JsonUiView

fn clone(&self) -> JsonUiView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonUiView

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

Formats the value using the given formatter.

impl Default for JsonUiView

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonUiView

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for JsonUiView

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for JsonUiView

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 JsonUiView