tink_core/keyset/
reader.rs

1// Copyright 2020 The Tink-Rust Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//      http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14//
15////////////////////////////////////////////////////////////////////////////////
16
17//! Trait definition for reading keysets.
18
19/// `Reader` knows how to read a [`Keyset`](tink_proto::Keyset) or an
20/// [`EncryptedKeyset`](tink_proto::EncryptedKeyset) from some source.
21///
22/// In order to turn a `Reader` into a [`keyset::Handle`](crate::keyset::Handle) for use, callers
23/// must use `insecure::new_handle` or [`Handle::read`](super::Handle::read) (with encryption).
24pub trait Reader {
25    /// Return a (cleartext) `Keyset` object from the underlying source.
26    fn read(&mut self) -> Result<tink_proto::Keyset, crate::TinkError>;
27
28    /// Return an `EncryptedKeyset` object from the underlying source.
29    fn read_encrypted(&mut self) -> Result<tink_proto::EncryptedKeyset, crate::TinkError>;
30}
tink_core/keyset/reader.rs

tink_core/keyset/
reader.rs
