Struct green_barrel::models::output_data::OutputData2

pub struct OutputData2 {
    pub is_valid: bool,
    pub final_doc: Option<Document>,
    pub final_model_json: Value,
    pub fields_name: Vec<String>,
}

Output data for check() and save() methods.

Fields

is_valid: bool

final_doc: Option<Document>

final_model_json: Value

fields_name: Vec<String>

Implementations

impl OutputData2

pub fn is_valid(&self) -> bool

Get validation status (boolean).

Example:

let mut model_name = ModelName::new()?;

let output_data = model_name.check()?;
// or
let output_data = model_name.save(None, None)?;

assert!(output_data.is_valid());

pub fn update<T>(&self) -> Result<T, Error>where
    T: DeserializeOwned + Sized,

If there are AutoSlug fields, do an update. Use only for save() method.

Example:

let mut model_name = ModelName::new()?;

let output_data = model_name.save(None, None)?;

if output_data.is_valid() {
    model_name = output_data.update()?;
}

pub fn hash(&self) -> String

Get/Set Hash-line

Example:

let mut model_name = ModelName::new()?;

let output_data = model_name.check(None)?;
// or
let output_data = model_name.save(None, None)?;

println!("{}", output_data.hash());
println!("{}", output_data.set_hash(hash_line));

pub fn set_hash(&mut self, hash: String)

pub fn obj_id(&self) -> Result<Option<ObjectId>, Box<dyn Error>>

Get MongoDB ID from hash-line

Example:

let mut model_name = ModelName::new()?;

let output_data = model_name.check()?;
// or
let output_data = model_name.save(None, None)?;

println!("{:?}", output_data.obj_id()?);

pub fn json(&self) -> Result<String, Box<dyn Error>>

Get Model instance in Json-line format.

Example:

let mut model_name = ModelName::new()?;

let output_data = model_name.check()?;
// or
let output_data = model_name.save(None, None)?;

println!("{}", output_data.json()?);

pub fn created_at(&self) -> Option<&str>

Get the creation date of the document.

Example:

let mut model_name = ModelName::new()?;

let output_data = model_name.check()?;
// or
let output_data = model_name.save(None, None)?;

println!("{}", output_data.created_at());

pub fn updated_at(&self) -> Option<&str>

Get the date the document was updated.

Example:

let mut model_name = ModelName::new()?;

let output_data = model_name.check()?;
// or
let output_data = model_name.save(None, None)?;

println!("{}", output_data.updated_at());

pub fn err_msg(&self) -> String

Get errors message ( for user side ).

Example:

let mut model_name = ModelName::new()?;

let output_data = model_name.check()?;
// or
let output_data = model_name.save(None, None)?;

if output_data.is_valid() {
    println!("{}", output_data.err_msg());
}

pub fn print_err(&self)

Printing errors to the console ( for development ).

Example:

let mut model_name = ModelName::new()?;

let output_data = model_name.check()?;
// or
let output_data = model_name.save(None, None)?;

if output_data.is_valid() {
    output_data.print_err();
}

pub fn json_for_admin(&self) -> Result<String, Box<dyn Error>>

Get field type list in json-line format for admin panel. ( converts a field type map to a list, in the order of the Model fields )

Example:

let mut model_name = ModelName::new()?;

let output_data = model_name.check()?;
// or
let output_data = model_name.save(None, None)?;

println!("{}", output_data.json_for_admin()?);

pub fn get_doc(&self) -> Option<Document>

Get/Set final document

Example:

let mut model_name = ModelName::new()?;

let output_data = model_name.check()?;
// or
let output_data = model_name.save(None, None)?;

println!("{:?}", output_data.get_doc());
println!("{:?}", output_data.set_doc(Some(new_doc)));

pub fn set_doc(&mut self, new_doc: Option<Document>)

pub fn model_json(&self) -> Value

Get Model instance in serde_json::Value format.

Example:

let mut model_name = ModelName::new()?
;
let output_data = model_name.check()?;
// or
let output_data = model_name.save(None, None)?;

println!("{:?}", output_data.model_json());

Trait Implementations

impl Converters for OutputData2

fn to_prepared_doc(
    doc: Document,
    ignore_fields: &[String],
    field_type_map: &HashMap<String, String>,
    model_name: &str
) -> Result<Document, Box<dyn Error>>

Get prepared document ( converting data types to model-friendly formats ).

fn one_to_json_val(
    db_doc: Document,
    ignore_fields: &[String],
    field_type_map: &HashMap<String, String>,
    model_name: &str,
    fields_name: &Vec<String>,
    model_json: &mut Value
) -> Result<(), Box<dyn Error>>

In the model instance, in the format serde_json::Value, Update the field type values from the corresponding document from the database.

fn many_to_doc_list(
    filter: Option<Document>,
    find_options: Option<FindOptions>,
    collection: Collection
) -> Result<Vec<Document>, Box<dyn Error>>

Get prepared documents ( missing fields type ).

fn many_to_json(
    filter: Option<Document>,
    find_options: Option<FindOptions>,
    collection: Collection,
    ignore_fields: &[String],
    field_type_map: &HashMap<String, String>,
    model_name: &str
) -> Result<Option<String>, Box<dyn Error>>

Get json-line from document list ( missing fields type ).

impl Debug for OutputData2

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

Formats the value using the given formatter.