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