Skip to main content

JsonFormat

Struct JsonFormat 

Source
pub struct JsonFormat {
    pub pretty: bool,
}
Expand description

Custom JSON format handler.

This format preserves all narrative structure and metadata, making it ideal for storing narratives in databases or exchanging between systems.

§Example

use spatial_narrative::io::{JsonFormat, Format};
use spatial_narrative::prelude::*;

let format = JsonFormat::new();

let event = Event::builder()
    .location(Location::new(40.7128, -74.006))
    .timestamp(Timestamp::now())
    .text("Something happened")
    .build();

let narrative = Narrative::builder()
    .title("My Story")
    .event(event)
    .build();

let json = format.export_str(&narrative).unwrap();
let restored = format.import_str(&json).unwrap();

assert_eq!(restored.events().len(), 1);

Fields§

§pretty: bool

Whether to pretty-print the JSON output

Implementations§

Source§

impl JsonFormat

Source

pub fn new() -> Self

Create a new JSON format handler.

Source

pub fn pretty() -> Self

Create a new JSON format handler with pretty printing enabled.

Trait Implementations§

Source§

impl Clone for JsonFormat

Source§

fn clone(&self) -> JsonFormat

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for JsonFormat

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for JsonFormat

Source§

fn default() -> JsonFormat

Returns the “default value” for a type. Read more
Source§

impl Format for JsonFormat

Source§

fn import<R: Read>(&self, reader: R) -> Result<Narrative>

Import a narrative from a reader. Read more
Source§

fn export<W: Write>(&self, narrative: &Narrative, writer: W) -> Result<()>

Export a narrative to a writer. Read more
Source§

fn import_str(&self, data: &str) -> Result<Narrative>

Import a narrative from a string. Read more
Source§

fn export_str(&self, narrative: &Narrative) -> Result<String>

Export a narrative to a string. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.