Trait WithSchema 

pub trait WithSchema {
    // Required method
    fn schema(version: u32, context: &mut WithSchemaContext) -> Schema;
}

This trait must be implemented by all data structures you wish to be able to save.

It must encode the schema for the datastructure when saved using the given version number. When files are saved, the schema is encoded into the file. when loading, the schema is inspected to make sure that the load will safely succeed. This is only for increased safety, the file format does not in fact use the schema for any other purpose, the design is schema-less at the core, the schema is just an added layer of safety (which can be disabled).

Required Methods

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

Returns a representation of the schema used by this Serialize implementation for the given version. The WithSchemaContext can be used to guard against recursive data structures. See documentation of WithSchemaContext.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl WithSchema for &str

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for IpAddr

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for SocketAddr

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for bool

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for char

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for f32

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for f64

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for i8

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for i16

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for i32

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for i64

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for i128

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for isize

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for str

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for u8

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for u16

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for u32

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for u64

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for u128

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for ()

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for usize

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for String

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for Arc<str>

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for AtomicBool

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for AtomicI8

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for AtomicI16

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for AtomicI32

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for AtomicI64

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for AtomicIsize

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for AtomicU8

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for AtomicU16

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for AtomicU32

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for AtomicU64

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for AtomicUsize

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for Duration

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for Error

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for PathBuf

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for SystemTime

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl WithSchema for BitSet

Available on crate feature bit-set only.

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl WithSchema for BitSet

Available on crate feature bit-set only.

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl WithSchema for BitVec

Available on crate feature bit-vec only.

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl WithSchema for BitVec

Available on crate feature bit-vec08 only.

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl WithSchema for DateTime<Utc>

Available on crate feature chrono only.

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl<'a, T: 'a + WithSchema + ToOwned + ?Sized> WithSchema for Cow<'a, T>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<K: WithSchema + Eq + Hash, S: BuildHasher> WithSchema for IndexSet<K, S>

Available on crate feature indexmap only.

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<K: WithSchema + Eq + Hash, V: WithSchema, S: BuildHasher> WithSchema for HashMap<K, V, S>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<K: WithSchema + Eq + Hash, V: WithSchema, S: BuildHasher> WithSchema for IndexMap<K, V, S>

Available on crate feature indexmap only.

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<K: WithSchema> WithSchema for BTreeSet<K>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<K: WithSchema, S: BuildHasher> WithSchema for HashSet<K, S>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<K: WithSchema, V: WithSchema> WithSchema for BTreeMap<K, V>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T1: WithSchema> WithSchema for (T1,)

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T1: WithSchema> WithSchema for Range<T1>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T1: WithSchema, T2: WithSchema> WithSchema for (T1, T2)

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T1: WithSchema, T2: WithSchema, T3: WithSchema> WithSchema for (T1, T2, T3)

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T> WithSchema for PhantomData<T>

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

impl<T: Array> WithSchema for SmallVec<T>

where T::Item: WithSchema,

Available on crate feature smallvec only.

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for &[T]

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for Option<T>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for Box<[T]>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for Box<T>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for BinaryHeap<T>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for VecDeque<T>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for Rc<T>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for Arc<[T]>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for Arc<T>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for Vec<T>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for Cell<T>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for RefCell<T>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for Mutex<T>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for Mutex<T>

Available on crate feature parking_lot only.

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema> WithSchema for RwLock<T>

Available on crate feature parking_lot only.

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema, R: WithSchema> WithSchema for Result<T, R>

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<T: WithSchema, const N: usize> WithSchema for [T; N]

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<V: WithSchema, const C: usize> WithSchema for ArrayVec<V, C>

Available on crate feature arrayvec only.

fn schema(version: u32, context: &mut WithSchemaContext) -> Schema

impl<const C: usize> WithSchema for ArrayString<C>

Available on crate feature arrayvec only.

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

Implementors

impl WithSchema for Schema

impl WithSchema for SchemaPrimitive

impl WithSchema for VecOrStringLayout

impl WithSchema for AbiMethod

impl WithSchema for AbiMethodArgument

impl WithSchema for AbiMethodInfo

impl WithSchema for AbiTraitDefinition

impl WithSchema for Canary1

impl WithSchema for Field

impl WithSchema for SchemaArray

impl WithSchema for SchemaEnum

impl WithSchema for SchemaStruct

impl WithSchema for Variant

impl<T: WithSchema> WithSchema for Removed<T>

impl<T: WithSchema, D: ValueConstructor<T>> WithSchema for AbiRemoved<T, D>