p2panda-rs 0.9.0

All the things a panda needs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

// SPDX-License-Identifier: AGPL-3.0-or-later

//! Error types for validating operation fields against schemas.
use thiserror::Error;

use crate::operation::error::PlainValueError;

/// Custom error types for validating raw operations with schemas.
#[derive(Error, Debug)]
pub enum ValidationError {
    /// Field with this name is required by schema.
    #[error("missing required field: '{0}' of type {1}")]
    MissingField(String, String),

    /// One or more fields which do not belong to the schema.
    #[error("unexpected fields found: {0}")]
    UnexpectedFields(String),

    /// Raw operation field did not match schema.
    #[error("field '{0}' does not match schema: {1}")]
    InvalidField(String, String),

    /// Field type and schema do not match.
    #[error("expected field name '{1}'")]
    InvalidName(String, String),

    /// Field type and schema do not match.
    #[error("invalid field type '{0}', expected '{1}'")]
    InvalidType(String, String),

    /// Field value is not correctly formatted.
    #[error("{0}")]
    InvalidValue(String),

    /// Field value is not in canonic format.
    #[error("non-canonic document view id, {0}")]
    InvalidDocumentViewId(String),

    /// Error from validating system schema: `schema_definition_v1`.
    #[error("invalid 'schema_definition_v1' operation: {0}")]
    InvalidSchemaDefinition(#[from] SchemaDefinitionError),

    /// Error from validating system schema: `schema_field_definition_v1`.
    #[error("invalid 'schema_field_definition_v1' operation: {0}")]
    InvalidSchemaFieldDefinition(#[from] SchemaFieldDefinitionError),

    /// Error from conversion of PlainValues.
    #[error(transparent)]
    NotStringValue(#[from] PlainValueError),

    /// Error from validating system schema: `blob_v1`.
    #[error("invalid 'blob_v1' operation: {0}")]
    InvalidBlob(#[from] BlobError),

    /// Error from validating system schema: `blob_piece_v1`.
    #[error("invalid 'blob_piece_v1' operation: {0}")]
    InvalidBlobPiece(#[from] BlobPieceError),
}

/// Custom error types for validating operations against `schema_field_definition_v1` schema.
#[derive(Error, Debug)]
#[allow(missing_copy_implementations)]
pub enum SchemaFieldDefinitionError {
    /// "name" is not correctly formatted as per specification.
    #[error("'name' field in schema field definitions is wrongly formatted")]
    NameInvalid,

    /// "type" is not correctly formatted as per specification.
    #[error("'type' field in schema field definitions is wrongly formatted")]
    TypeInvalid,

    /// Error from conversion of PlainValues.
    #[error(transparent)]
    NotStringValue(#[from] PlainValueError),
}

/// Custom error types for validating operations against `schema_field_definition_v1` schema.
#[derive(Error, Debug)]
#[allow(missing_copy_implementations)]
pub enum SchemaDefinitionError {
    /// "name" is not correctly formatted as per specification.
    #[error("'name' field in schema field definitions is wrongly formatted")]
    NameInvalid,

    /// "description" is not correctly formatted as per specification.
    #[error("'description' field in schema field definitions is wrongly formatted")]
    DescriptionInvalid,

    /// "fields" is not correctly formatted as per specification.
    #[error("'fields' field in schema field definitions is wrongly formatted")]
    FieldsInvalid,

    /// Error from conversion of PlainValues.
    #[error(transparent)]
    NotStringValue(#[from] PlainValueError),
}

/// Custom error types for validating operations against `blob_v1` schema.
#[derive(Error, Debug)]
#[allow(missing_copy_implementations)]
pub enum BlobError {
    /// "mime_type" is not correctly formatted as per specification.
    #[error("'mime_type' field in blob is wrongly formatted")]
    MimeTypeInvalid,

    /// "pieces" can not be empty as per specification.
    #[error("'pieces' field can not be empty")]
    PiecesEmpty,
}

/// Custom error types for validating operations against `blob_piece_v1` schema.
#[derive(Error, Debug)]
#[allow(missing_copy_implementations)]
pub enum BlobPieceError {
    /// "data" is greater than the maximum allowed as per specification.
    #[error("'data' field in blob is over maximum allowed length")]
    DataInvalid,
}