mirror of
https://github.com/saymrwulf/betrusted-curve25519-dalek-source.git
synced 2026-09-05 20:30:54 +00:00
ad7c755f49
This change migrates all the documentation from dalek.rs to docs.rs hosted and fixed the backend documentation generation that was broken.
85 lines
2.4 KiB
Rust
85 lines
2.4 KiB
Rust
// -*- mode: rust; -*-
|
|
//
|
|
// This file is part of curve25519-dalek.
|
|
// Copyright (c) 2016-2021 isis lovecruft
|
|
// Copyright (c) 2016-2019 Henry de Valence
|
|
// See LICENSE for licensing information.
|
|
//
|
|
// Authors:
|
|
// - isis agora lovecruft <isis@patternsinthevoid.net>
|
|
// - Henry de Valence <hdevalence@hdevalence.ca>
|
|
|
|
#![no_std]
|
|
#![cfg_attr(feature = "nightly", feature(test))]
|
|
#![cfg_attr(feature = "nightly", feature(doc_cfg))]
|
|
#![cfg_attr(feature = "simd_backend", feature(stdsimd))]
|
|
//------------------------------------------------------------------------
|
|
// Documentation:
|
|
//------------------------------------------------------------------------
|
|
#![deny(missing_docs)]
|
|
#![doc(
|
|
html_logo_url = "https://cdn.jsdelivr.net/gh/dalek-cryptography/curve25519-dalek/docs/assets/dalek-logo-clear.png"
|
|
)]
|
|
#![doc(html_root_url = "https://docs.rs/curve25519-dalek/4.0.0-pre.2")]
|
|
#![doc = include_str!("../README.md")]
|
|
|
|
//------------------------------------------------------------------------
|
|
// External dependencies:
|
|
//------------------------------------------------------------------------
|
|
|
|
#[cfg(feature = "alloc")]
|
|
#[allow(unused_imports)]
|
|
#[macro_use]
|
|
extern crate alloc;
|
|
|
|
#[cfg(feature = "std")]
|
|
#[macro_use]
|
|
extern crate std;
|
|
|
|
pub use digest;
|
|
|
|
// Internal macros. Must come first!
|
|
#[macro_use]
|
|
pub(crate) mod macros;
|
|
|
|
//------------------------------------------------------------------------
|
|
// curve25519-dalek public modules
|
|
//------------------------------------------------------------------------
|
|
|
|
// Scalar arithmetic mod l = 2^252 + ..., the order of the Ristretto group
|
|
pub mod scalar;
|
|
|
|
// Point operations on the Montgomery form of Curve25519
|
|
pub mod montgomery;
|
|
|
|
// Point operations on the Edwards form of Curve25519
|
|
pub mod edwards;
|
|
|
|
// Group operations on the Ristretto group
|
|
pub mod ristretto;
|
|
|
|
// Useful constants, like the Ed25519 basepoint
|
|
pub mod constants;
|
|
|
|
// External (and internal) traits.
|
|
pub mod traits;
|
|
|
|
//------------------------------------------------------------------------
|
|
// curve25519-dalek internal modules
|
|
//------------------------------------------------------------------------
|
|
|
|
// Finite field arithmetic mod p = 2^255 - 19
|
|
pub(crate) mod field;
|
|
|
|
// Arithmetic backends (using u32, u64, etc) live here
|
|
#[cfg(docsrs)]
|
|
pub mod backend;
|
|
#[cfg(not(docsrs))]
|
|
pub(crate) mod backend;
|
|
|
|
// Crate-local prelude (for alloc-dependent features like `Vec`)
|
|
|
|
pub(crate) mod prelude;
|
|
|
|
// Generic code for window lookups
|
|
pub(crate) mod window;
|