API

`#net/textproto`

import: #net/textproto

counts: 5 fns, 7 methods, 3 types, 0 consts, 0 ifaces

MIME header canonicalization and parse.

`struct MIMEHeader`

XuAPI

pub struct MIMEHeader {
    pub keys []string
    pub vals []string
}

Purpose

Text protocol helpers aligned with `net/textproto` CanonicalMIMEHeaderKey, TrimString, ReadMIMEHeader (from an owning string), and a status-line parse (SMTP/HTTP-style `250 OK` / `250-`). No map: MIMEHeader uses parallel keys/vals.

Parameters

keys []string: field ([]string)
vals []string: field ([]string)

`struct HeaderRead`

XuAPI

pub struct HeaderRead {
    pub header MIMEHeader
    pub rest string
}

Purpose

Public struct `HeaderRead`.

Parameters

header MIMEHeader: field (MIMEHeader)
rest string: field (string)

`struct CodeLine`

XuAPI

pub struct CodeLine {
    pub code int
    pub msg string
    pub cont bool
}

Purpose

Public struct `CodeLine`.

Parameters

code int: code
msg string: message
cont bool: field (bool)

`canonical_mime_header_key`

XuAPI

pub fn canonical_mime_header_key(s &string) string

Purpose

Canonical mime header key.

Parameters

s &string: source string (borrowed; caller keeps it; type &string)

Returns

string — result string

`trim_string`

XuAPI

pub fn trim_string(s &string) string

Purpose

Trim string.

Parameters

s &string: source string (borrowed; caller keeps it; type &string)

Returns

string — result string

`new_header`

XuAPI

pub fn new_header() MIMEHeader

Purpose

Construct header.

Parameters

none

Returns

MIMEHeader — a value of this type

`(MIMEHeader) get`

XuAPI

pub fn (h MIMEHeader) get(key &string) string

Purpose

Call `get` on `MIMEHeader`.

Parameters

h MIMEHeader: receiver MIMEHeader (value receiver)
key &string: key (borrowed; caller keeps it; type &string)

Returns

string — result string

`(MIMEHeader) values`

XuAPI

pub fn (h MIMEHeader) values(key &string) []string

Purpose

Call `values` on `MIMEHeader`.

Parameters

h MIMEHeader: receiver MIMEHeader (value receiver)
key &string: key (borrowed; caller keeps it; type &string)

Returns

[]string — slice result

`(&mut MIMEHeader) add`

XuAPI

pub fn (h &mut MIMEHeader) add(key &string, value &string)

Purpose

Method on `&mut MIMEHeader`: add.

Parameters

h &mut MIMEHeader: receiver &mut MIMEHeader (exclusive borrow)
key &string: key (borrowed; caller keeps it; type &string)
value &string: value (borrowed; caller keeps it; type &string)

`(&mut MIMEHeader) del`

XuAPI

pub fn (h &mut MIMEHeader) del(key &string)

Purpose

Call `del` on `&mut MIMEHeader`.

Parameters

h &mut MIMEHeader: receiver &mut MIMEHeader (exclusive borrow)
key &string: key (borrowed; caller keeps it; type &string)

`(&mut MIMEHeader) set`

XuAPI

pub fn (h &mut MIMEHeader) set(key &string, value &string)

Purpose

Call `set` on `&mut MIMEHeader`.

Parameters

h &mut MIMEHeader: receiver &mut MIMEHeader (exclusive borrow)
key &string: key (borrowed; caller keeps it; type &string)
value &string: value (borrowed; caller keeps it; type &string)

`(MIMEHeader) len`

XuAPI

pub fn (h MIMEHeader) len() int

Purpose

Method on `MIMEHeader`: return the length.

Parameters

h MIMEHeader: receiver MIMEHeader (value receiver)

Returns

int — a value of this type

`(MIMEHeader) clone`

XuAPI

pub fn (h MIMEHeader) clone() MIMEHeader

Purpose

Method on `MIMEHeader`: copy into a new independent string.

Parameters

h MIMEHeader: receiver MIMEHeader (value receiver)

Returns

MIMEHeader — a value of this type

`read_mime_header`

XuAPI

pub fn read_mime_header(src &string) HeaderRead

Purpose

Read mime header.

Parameters

src &string: source (borrowed; caller keeps it; type &string)

Returns

HeaderRead — a value of this type

`parse_code_line`

XuAPI

pub fn parse_code_line(line &string) CodeLine

Purpose

Parse as code line. Throws on failure.

Parameters

line &string: line (borrowed; caller keeps it; type &string)

Returns

CodeLine — a value of this type