file

Documentation

Overview

Package file provides the standard file library used to perform common file operations.

Index

• func Include() script.Option
• func Library() script.Library
• type File
  • func ParseParam(parser script.ArgParser, index int) (*File, error)
  • func (f *File) Freeze()
  • func (f *File) Hash() (uint32, error)
  • func (f *File) Name() string
  • func (f *File) String() string
  • func (f *File) Truth() starlark.Bool
  • func (f *File) Type() string

Functions

func Include

func Include() script.Option

Include the file library in a script environment.

func Library

func Library() script.Library

Library prepares a new file library for use within a script environment.

Types

type File

type File struct {
	afero.Fs

	Path string
}

File descriptor that can be used with the file library and implements starlark.Value.

func ParseParam

func ParseParam(parser script.ArgParser, index int) (*File, error)

ParseParam from starlark input

func (*File) Freeze

func (f *File) Freeze()

Freeze is a no-op since the underlying file is safe for concurrent use.

func (*File) Hash

func (f *File) Hash() (uint32, error)

Hash will error since the file type is not intended to be hashable.

func (*File) Name

func (f *File) Name() string

Name returns the path used to create the file descriptor.

func (*File) String

func (f *File) String() string

String returns the name of the file.

func (*File) Truth

func (f *File) Truth() starlark.Bool

Truth value of a file is True if the file is non-nil

func (*File) Type

func (f *File) Type() string

Type returns 'file' to indicate the type of the file within starlark.