starlark 0.14.0

An implementation of the Starlark language in Rust.
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

/*
 * Copyright 2019 The Starlark in Rust Authors.
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

//! Error types for pagable serialization/deserialization.

use thiserror::Error;

use crate::pagable::DeserTypeId;

/// Errors that can occur during pagable serialization/deserialization.
#[derive(Debug, Error)]
pub enum PagableError {
    /// The type was not registered in the vtable registry.
    #[error("Type `{type_id}` was not registered for deserialization.")]
    TypeNotRegistered {
        /// The type identifier that was not found.
        type_id: DeserTypeId,
    },

    /// The total bytes declared for an arena bump do not match what was actually deserialized.
    #[error(
        "Corrupted data: {count} values consumed {actual_bytes} bytes but expected {expected_bytes}"
    )]
    InconsistentArenaSize {
        /// Number of values deserialized.
        count: usize,
        /// Bytes declared in the serialized header.
        expected_bytes: u32,
        /// Bytes actually consumed by deserialized values.
        actual_bytes: u32,
    },

    /// Heap bases not registered for the heap a `FrozenValue` resolves to.
    #[error("Heap bases not registered for heap {heap_id:?}")]
    HeapBasesNotRegistered {
        /// The HeapRefId whose bases were not found.
        heap_id: crate::pagable::heap_ref_id::HeapRefId,
    },

    /// A `StarlarkPagable`-derived enum was deserialized with an unknown variant tag.
    #[error("Invalid `{enum_name}` variant tag: {tag}")]
    InvalidVariantTag {
        /// Name of the enum being deserialized.
        enum_name: &'static str,
        /// The tag byte read from the input.
        tag: u8,
    },
}

impl From<PagableError> for crate::Error {
    fn from(e: PagableError) -> Self {
        crate::Error::new_kind(crate::ErrorKind::Other(anyhow::Error::new(e)))
    }
}