snarkvm_console_network_environment/traits/
to_field.rs

1// Copyright (c) 2019-2025 Provable Inc.
2// This file is part of the snarkVM library.
3
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at:
7
8// http://www.apache.org/licenses/LICENSE-2.0
9
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16use super::FieldTrait;
17
18use anyhow::Result;
19
20/// Unary operator for converting to a base field.
21pub trait ToField {
22    type Field: FieldTrait;
23
24    /// Returns the object as a base field element.
25    fn to_field(&self) -> Result<Self::Field>;
26}
27
28/// Unary operator for converting to a list of base fields.
29pub trait ToFields {
30    type Field: FieldTrait;
31
32    /// Returns the object as a list of base field elements.
33    fn to_fields(&self) -> Result<Vec<Self::Field>>;
34}
35
36/// Unary operator for converting to a list of base fields.
37pub trait ToFieldsRaw: ToFields {
38    /// Returns the object as a list of base field elements using the raw bits.
39    fn to_fields_raw(&self) -> Result<Vec<Self::Field>>;
40}