Documentation
¶
Overview ¶
Package ZIPPacker provides methods for working with ZIPPacker object instances.
Index ¶
- type Advanced
- type Any
- type Expanded
- type Extension
- type ID
- type Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsZIPPacker() Instance
- func (self Instance) Close() error
- func (self Instance) CloseFile() error
- func (self Instance) ID() ID
- func (self Instance) Open(path string) error
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) StartFile(path string) error
- func (self Instance) Virtual(name string) reflect.Value
- func (self Instance) WriteFile(data []byte) error
- type ZipAppend
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsZIPPacker ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
This class implements a writer that allows storing the multiple blobs in a ZIP archive. See also [ZIPReader] and [PCKPacker]. [codeblock] # Create a ZIP archive with a single file at its root. func write_zip_file():
var writer = ZIPPacker.new()
var err = writer.open("user://archive.zip")
if err != OK:
return err
writer.start_file("hello.txt")
writer.write_file("Hello World".to_utf8_buffer())
writer.close_file()
writer.close()
return OK
[/codeblock]
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsZIPPacker ¶
func (Instance) CloseFile ¶
Stops writing to a file within the archive. It will fail if there is no open file.
func (Instance) Open ¶
Opens a zip file for writing at the given path using the specified write mode. This must be called before everything else.
Source Files