Source file src/crypto/internal/boring/doc.go

     1  // Copyright 2017 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  // Package boring provides access to BoringCrypto implementation functions.
     6  // Check the constant Enabled to find out whether BoringCrypto is available.
     7  // If BoringCrypto is not available, the functions in this package all panic.
     8  package boring
     9  
    10  // Enabled reports whether BoringCrypto is available.
    11  // When enabled is false, all functions in this package panic.
    12  //
    13  // BoringCrypto is only available on linux/amd64 and linux/arm64 systems.
    14  const Enabled = available
    15  
    16  // A BigInt is the raw words from a BigInt.
    17  // This definition allows us to avoid importing math/big.
    18  // Conversion between BigInt and *big.Int is in crypto/internal/boring/bbig.
    19  type BigInt []uint
    20  

View as plain text