github.com/solo-io/cue@v0.4.7/pkg/doc.go (about)

     1  // Copyright 2018 The CUE 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  // Package pkg define CUE standard packages.
    16  //
    17  // Many of the standard packages are modeled after and generated from the Go
    18  // core packages. The types, values, and functions are defined as their Go
    19  // equivalence and mapped to CUE types.
    20  //
    21  // Beware that some packages are defined in lesser-precision types than are
    22  // typically used in CUE and thus may lead to loss of precision.
    23  //
    24  // All packages except those defined in the tool subdirectory are hermetic,
    25  // that is depending only on a known set of inputs, and therefore can guarantee
    26  // reproducible results.  That is:
    27  //
    28  //   - no reading of files contents
    29  //   - no querying of the file system of any kind
    30  //   - no communication on the network
    31  //   - no information about the type of environment
    32  //   - only reproduceable random generators
    33  //
    34  // Hermetic configurations allow for fast and advanced analysis that otherwise
    35  // would not be possible or practical. The cue "cmd" command can be used to mix
    36  // in non-hermetic influences into configurations by using packages defined
    37  // in the tool subdirectory.
    38  package pkg