filename

Documentation

Overview

Package filename provides utilities for encoder.

Index

• Variables
• func Decode(s string) (string, error)
• func DecodeBytes(table byte, data []byte) (string, error)
• func Encode(s string) string
• func EncodeBytes(s string) (table byte, payload []byte)

Variables

var ErrCorrupted = errors.New("file name corrupt")

ErrCorrupted is returned if a provided encoded filename cannot be decoded.

var ErrUnsupported = errors.New("file name possibly generated by future version of rclone")

ErrUnsupported is returned if a provided encoding may come from a future version or the file name is corrupt.

Functions

func Decode

func Decode(s string) (string, error)

Decode an encoded string.

func DecodeBytes

func DecodeBytes(table byte, data []byte) (string, error)

DecodeBytes will decode raw id and data values.

func Encode

func Encode(s string) string

Encode will encode the string and return a base64 (url) compatible version of it. Calling Decode with the returned string should always succeed. It is not a requirement that the input string is valid utf-8.

func EncodeBytes

func EncodeBytes(s string) (table byte, payload []byte)

EncodeBytes will compress the given string and return a table identifier and a payload.