ring/error/input_too_long.rs
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
// Copyright 2024 Brian Smith.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
// OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
pub struct InputTooLongError<T = usize> {
/// Note that this might not actually be the (exact) length of the input,
/// and its units might be lost. For example, it could be any of the
/// following:
///
/// * The length in bytes of the entire input.
/// * The length in bytes of some *part* of the input.
/// * A bit length.
/// * A length in terms of "blocks" or other grouping of input values.
/// * Some intermediate quantity that was used when checking the input
/// length.
/// * Some arbitrary value.
#[allow(dead_code)]
imprecise_input_length: T,
}
impl<T> InputTooLongError<T> {
#[cold]
#[inline(never)]
pub(crate) fn new(imprecise_input_length: T) -> Self {
Self {
imprecise_input_length,
}
}
}