github.com/hpcng/singularity@v3.1.1+incompatible/pkg/image/doc.go (about)

     1  // Copyright (c) 2018, Sylabs Inc. All rights reserved.
     2  // This software is licensed under a 3-clause BSD license. Please consult the
     3  // LICENSE.md file distributed with the sources of this project regarding your
     4  // rights to use or distribute this software.
     5  
     6  /*
     7  Package image provides underlying data types for Singularity image
     8  formats. Additionally, all image types will satisfy the ImageFormat{}
     9  interface. This interface will expose all things necessary to use
    10  a Singularity image, whether through OCI or directly.
    11  
    12  type ImageFormat interface {
    13      Root() *spec.Root - Root() returns the OCI compliant root of the
    14                          Image. This function may preform some action,
    15                          such as extracting the filesystem to a dir.
    16  
    17  }
    18  */
    19  package image