Пакет mime

• import "mime"
• Обзор
• Индекс
• Примеры
• Подкаталоги

Обзор

Пакет mime реализует части спецификации MIME.

Индекс

• Константы
• Переменные
• Функция AddExtensionType(ext, typ string) error
• Функция ExtensionsByType(typ string) ([]string, error)
• Функция FormatMediaType(t string, param map[string]string) string
• Функция ParseMediaType(v string) (mediatype string, params map[string]string, err error)
• Функция TypeByExtension(ext string) string
• Тип WordDecoder
• Функция (d *WordDecoder) Decode(word string) (string, error)
• Функция (d *WordDecoder) DecodeHeader(header string) (string, error)
• Тип WordEncoder
• Функция (e WordEncoder) Encode(charset, s string) string

Файлы пакета

encodedword.go grammar.go mediatype.go type.go type_unix.go

Константы

const (
    // BEncoding represents Base64 encoding scheme as defined by RFC 2045.
    BEncoding = WordEncoder('b')
    // QEncoding represents the Q-encoding scheme as defined by RFC 2047.
    QEncoding = WordEncoder('q')
)

Переменные

ErrInvalidMediaParameter возвращается функцией ParseMediaType, если значение медиа типа найдено, но при парсинге необязательных параметров произошла ошибка.

var ErrInvalidMediaParameter = errors.New("mime: invalid media parameter")

Функция AddExtensionType

func AddExtensionType(ext, typ string) error

AddExtensionType устанавливает тип MIME, связанный с расширением ext, на typ. Расширение должно начинаться с ведущей точки, как в ".html".

Функция ExtensionsByType 1.5

func ExtensionsByType(typ string) ([]string, error)

ExtensionsByType возвращает расширения, известные как связанные с типом MIME typ. Возвращаемые расширения будут начинаться с ведущей точки, как в ".html". Когда у typ нет связанных расширений, ExtensionsByType возвращает пустой срез.

Функция FormatMediaType

func FormatMediaType(t string, param map[string]string) string

FormatMediaType сериализует mediatype t и параметры param как тип медиа, соответствующий RFC 2045 и RFC 2616. Имена типа и параметров записываются в нижнем регистре. Если какой-либо из аргументов приводит к нарушению стандарта, FormatMediaType возвращает пустую строку.

Пример

Код:

mediatype := "text/html"
params := map[string]string{
    "charset": "utf-8",
}

result := mime.FormatMediaType(mediatype, params)

fmt.Println("result:", result)

Вывод:

result: text/html; charset=utf-8

Функция ParseMediaType

func ParseMediaType(v string) (mediatype string, params map[string]string, err error)

ParseMediaType анализирует значение типа медиа и любые необязательные параметры, согласно RFC 1521. Типы медиа являются значениями в заголовках Content-Type и Content-Disposition (RFC 2183). При успешном выполнении ParseMediaType возвращает тип медиа, преобразованный в нижний регистр и очищенный от пробелов, и непустой словарь. Если возникает ошибка при разборе необязательного параметра, тип медиа будет возвращен вместе с ошибкой ErrInvalidMediaParameter. Возвращаемый словарь, params, отображает от нижнего регистра атрибута к значению атрибута, сохраняя его регистр.

Пример

Код:

mediatype, params, err := mime.ParseMediaType("text/html; charset=utf-8")
if err != nil {
    panic(err)
}

fmt.Println("type:", mediatype)
fmt.Println("charset:", params["charset"])

Вывод:

type: text/html
charset: utf-8

Функция TypeByExtension

func TypeByExtension(ext string) string

TypeByExtension возвращает тип MIME, связанный с расширением файла ext. Расширение ext должно начинаться с ведущей точки, как в ".html". Если у ext нет связанного типа, TypeByExtension возвращает "".

Расширения сначала ищутся в регистрозависимом виде, затем в регистронезависимом.

Встроенная таблица небольшая, но на Unix она дополняется базой данных MIME-информации или файлом mime.types локальной системы, если доступны под одним или несколькими из этих имен:

/usr/local/share/mime/globs2
/usr/share/mime/globs2
/etc/mime.types
/etc/apache2/mime.types
/etc/apache/mime.types

В Windows типы MIME извлекаются из реестра.

Текстовые типы по умолчанию имеют параметр charset, установленный в "utf-8".

Тип WordDecoder 1.5

WordDecoder декодирует заголовки MIME, содержащие закодированные слова RFC 2047.

type WordDecoder struct {
    // CharsetReader, if non-nil, defines a function to generate
    // charset-conversion readers, converting from the provided
    // charset into UTF-8.
    // Charsets are always lower-case. utf-8, iso-8859-1 and us-ascii charsets
    // are handled by default.
    // One of the CharsetReader's result values must be non-nil.
    CharsetReader func(charset string, input io.Reader) (io.Reader, error)
}

Функция (*WordDecoder) Decode 1.5

func (d *WordDecoder) Decode(word string) (string, error)

Decode декодирует закодированное слово RFC 2047.

Пример

Код:

dec := new(mime.WordDecoder)
header, err := dec.Decode("=?utf-8?q?=C2=A1Hola,_se=C3=B1or!?=")
if err != nil {
    panic(err)
}
fmt.Println(header)

dec.CharsetReader = func(charset string, input io.Reader) (io.Reader, error) {
    switch charset {
    case "x-case":
        // Fake character set for example.
        // Real use would integrate with packages such
        // as code.google.com/p/go-charset
        content, err := io.ReadAll(input)
        if err != nil {
            return nil, err
        }
        return bytes.NewReader(bytes.ToUpper(content)), nil
    default:
        return nil, fmt.Errorf("unhandled charset %q", charset)
    }
}
header, err = dec.Decode("=?x-case?q?hello!?=")
if err != nil {
    panic(err)
}
fmt.Println(header)

Вывод:

¡Hola, señor!
HELLO!

Функция (*WordDecoder) DecodeHeader 1.5

func (d *WordDecoder) DecodeHeader(header string) (string, error)

DecodeHeader декодирует все закодированные слова заданной строки. Возвращает ошибку, если и только если WordDecoder.CharsetReader от d возвращает ошибку.

Пример

Код:

dec := new(mime.WordDecoder)
header, err := dec.DecodeHeader("=?utf-8?q?=C3=89ric?= <eric@example.org>, =?utf-8?q?Ana=C3=AFs?= <anais@example.org>")
if err != nil {
    panic(err)
}
fmt.Println(header)

header, err = dec.DecodeHeader("=?utf-8?q?=C2=A1Hola,?= =?utf-8?q?_se=C3=B1or!?=")
if err != nil {
    panic(err)
}
fmt.Println(header)

dec.CharsetReader = func(charset string, input io.Reader) (io.Reader, error) {
    switch charset {
    case "x-case":
        // Fake character set for example.
        // Real use would integrate with packages such
        // as code.google.com/p/go-charset
        content, err := io.ReadAll(input)
        if err != nil {
            return nil, err
        }
        return bytes.NewReader(bytes.ToUpper(content)), nil
    default:
        return nil, fmt.Errorf("unhandled charset %q", charset)
    }
}
header, err = dec.DecodeHeader("=?x-case?q?hello_?= =?x-case?q?world!?=")
if err != nil {
    panic(err)
}
fmt.Println(header)

Вывод:

Éric <eric@example.org>, Anaïs <anais@example.org>
¡Hola, señor!
HELLO WORLD!

Тип WordEncoder 1.5

WordEncoder — это кодировщик закодированных слов RFC 2047.

type WordEncoder byte

Функция (WordEncoder) Encode 1.5

func (e WordEncoder) Encode(charset, s string) string

Encode возвращает закодированную форму s в виде закодированного слова. Если s является ASCII без специальных символов, она возвращается без изменений. Предоставленный charset — это имя набора символов IANA для s. Он регистронезависим.

Пример

Код:

fmt.Println(mime.QEncoding.Encode("utf-8", "¡Hola, señor!"))
fmt.Println(mime.QEncoding.Encode("utf-8", "Hello!"))
fmt.Println(mime.BEncoding.Encode("UTF-8", "¡Hola, señor!"))
fmt.Println(mime.QEncoding.Encode("ISO-8859-1", "Caf\xE9"))

Вывод:

=?utf-8?q?=C2=A1Hola,_se=C3=B1or!?=
Hello!
=?UTF-8?b?wqFIb2xhLCBzZcOxb3Ih?=
=?ISO-8859-1?q?Caf=E9?=

Подкаталоги