object_model

Documentation

Index

• type FileSystemObjects
  • func (fileSystemObject *FileSystemObjects) AbsoluteLevel() int
  • func (fileSystemObject *FileSystemObjects) AbsolutePathString() string
  • func (fileSystemObject *FileSystemObjects) BaseName() string
  • func (fileSystemObject *FileSystemObjects) Copy(targetPath string) (int64, error)
  • func (fileSystemObject *FileSystemObjects) CreateIfNonExistent() (bool, error)
  • func (fileSystemObject *FileSystemObjects) Exists() bool
  • func (fileSystemObject *FileSystemObjects) ExtendPath(pathExtension string) string
  • func (fileSystemObject *FileSystemObjects) Initialise(absolutePathString string)
  • func (fileSystemObject *FileSystemObjects) ItemCount() int
  • func (fileSystemObject *FileSystemObjects) ListOfComponents() []string
  • func (fileSystemObject *FileSystemObjects) ParentAbsolutePathString() string
• type Files
  • func (file *Files) Initialise(absolutePathString string, additionalParentFolder ...*Folders)
  • func (file *Files) ParentFolder() *Folders
• type Folders
  • func (folder *Folders) Initialise(absolutePathString string, parentFolder *Folders)

Types

type FileSystemObjects

type FileSystemObjects struct {
	Uuid *uuid_service.UUIDs
	Path *wrappers.AbsolutePathWrappers
}

func (*FileSystemObjects) AbsoluteLevel

func (fileSystemObject *FileSystemObjects) AbsoluteLevel() int

@property def absolute_level( self) \ -> int:

func (*FileSystemObjects) AbsolutePathString

func (fileSystemObject *FileSystemObjects) AbsolutePathString() string

@property def absolute_path_string( self) \ -> str:

func (*FileSystemObjects) BaseName

func (fileSystemObject *FileSystemObjects) BaseName() string

@property def base_name( self) \ -> str:

func (*FileSystemObjects) Copy

func (fileSystemObject *FileSystemObjects) Copy(targetPath string) (int64, error)

func (*FileSystemObjects) CreateIfNonExistent

func (fileSystemObject *FileSystemObjects) CreateIfNonExistent() (bool, error)

func (*FileSystemObjects) Exists

func (fileSystemObject *FileSystemObjects) Exists() bool

def exists( self) \ -> bool:

func (*FileSystemObjects) ExtendPath

func (fileSystemObject *FileSystemObjects) ExtendPath(pathExtension string) string

def extend_path( self, path_extension: str) \ -> str:

func (*FileSystemObjects) Initialise

func (fileSystemObject *FileSystemObjects) Initialise(

	absolutePathString string)

def __init__( self,

func (*FileSystemObjects) ItemCount

func (fileSystemObject *FileSystemObjects) ItemCount() int

def item_count( self) \ -> int:

func (*FileSystemObjects) ListOfComponents

func (fileSystemObject *FileSystemObjects) ListOfComponents() []string

def list_of_components(self):

func (*FileSystemObjects) ParentAbsolutePathString

func (fileSystemObject *FileSystemObjects) ParentAbsolutePathString() string

@property def parent_absolute_path_string( self) \ -> str:

type Files

type Files struct {
	FileSystemObjects
	// contains filtered or unexported fields
}

func (*Files) Initialise

func (file *Files) Initialise(
	absolutePathString string,
	additionalParentFolder ...*Folders)

func (*Files) ParentFolder

func (file *Files) ParentFolder() *Folders

type Folders

type Folders struct {
	*FileSystemObjects
	ParentFolder *Folders
	ChildFolders []*Folders
	ChildFiles   []*Files
}

func (*Folders) Initialise

func (folder *Folders) Initialise(
	absolutePathString string,
	parentFolder *Folders)

def __init__(

self,
absolute_path_string: str,
parent_folder: 'Folders' = None):