HashingContext

package
v0.0.0-...-c858641 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 14, 2025 License: MIT Imports: 22 Imported by: 0

Documentation

Overview

The HashingContext class provides an interface for computing cryptographic hashes over multiple iterations. Useful for computing hashes of big files (so you don't have to load them all in memory), network streams, and data streams in general (so you don't have to hold buffers).

The HashType enum shows the supported hashing algorithms.

package main

import (
	"encoding/hex"
	"fmt"

	"graphics.gd/classdb/FileAccess"
	"graphics.gd/classdb/HashingContext"
)

const ChunkSize = 1024

func HashFile(path string) {
	if !FileAccess.FileExists(path) {
		return
	}
	var ctx = HashingContext.New()
	ctx.Start(HashingContext.HashSha256)
	var file = FileAccess.Open(path, FileAccess.Read)
	for file.GetPosition() < file.GetLength() {
		remaining := int(file.GetLength() - file.GetPosition())
		ctx.Update(file.GetBuffer(min(remaining, ChunkSize)))
	}
	res := ctx.Finish()
	fmt.Println(hex.EncodeToString(res), res)
}

Index

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 Any

type Any interface {
	gd.IsClass
	AsHashingContext() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]) AsHashingContext

func (self *Extension[T]) AsHashingContext() Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

type HashType

type HashType int //gd:HashingContext.HashType
const (
	// Hashing algorithm: MD5.
	HashMd5 HashType = 0
	// Hashing algorithm: SHA-1.
	HashSha1 HashType = 1
	// Hashing algorithm: SHA-256.
	HashSha256 HashType = 2
)

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.HashingContext

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsHashingContext

func (self Instance) AsHashingContext() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) Finish

func (self Instance) Finish() []byte

Closes the current context, and return the computed hash.

func (Instance) ID

func (self Instance) ID() ID

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) Start

func (self Instance) Start(atype HashType) error

Starts a new hash computation of the given 'type' (e.g. HashSha256 to start computation of an SHA-256).

func (Instance) Update

func (self Instance) Update(chunk []byte) error

Updates the computation with the given 'chunk' of data.

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL