API
#testing
Xu 0.8.8 API
import: #testing
counts: 4 fns, 22 methods, 2 types, 0 consts, 0 ifaces
T: error/fatal/skip/run and *f formatters. LIFO cleanup. Cannot import outside test builds.
struct T
pub struct T {
pub failed int
pub skipped int
pub name string
pub cleanups []fn()
}
Purpose
Public struct `T`.
Parameters
failed int- field (int)
skipped int- field (int)
name string- name
cleanups []fn()- field ([]fn())
t
Purpose
t; returns T.
Parameters
none
Returns
T — a value of this type
t_named
pub fn t_named(name string) T
Purpose
T named.
Parameters
name string- name (string)
Returns
T — a value of this type
(T) name
pub fn (t T) name() string
Purpose
Call `name` on `T`.
Parameters
t T- receiver T (value receiver)
Returns
string — result string
(T) helper
Purpose
Call `helper` on `T`.
Parameters
t T- receiver T (value receiver)
(T) failed
pub fn (t T) failed() bool
Purpose
Call `failed` on `T`.
Parameters
t T- receiver T (value receiver)
Returns
bool — true or false
(T) skipped
pub fn (t T) skipped() bool
Purpose
Call `skipped` on `T`.
Parameters
t T- receiver T (value receiver)
Returns
bool — true or false
(&mut T) log
pub fn (t &mut T) log(msg &string)
Purpose
Method on `&mut T`: natural logarithm.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
msg &string- message (borrowed; caller keeps it; type &string)
(&mut T) logf
pub fn (t &mut T) logf(f string, args <-> fmt.Arg)
Purpose
Call `logf` on `&mut T`.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
f string- callback or format string (string)
args <-> fmt.Arg- variadic fmt.Arg (seen inside the function as []fmt.Arg)
(&mut T) fail
Purpose
Call `fail` on `&mut T`.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
(&mut T) error
pub fn (t &mut T) error(msg &string)
Purpose
Call `error` on `&mut T`.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
msg &string- message (borrowed; caller keeps it; type &string)
(&mut T) errorf
pub fn (t &mut T) errorf(f string, args <-> fmt.Arg)
Purpose
Method on `&mut T`: build an error from a format string.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
f string- callback or format string (string)
args <-> fmt.Arg- variadic fmt.Arg (seen inside the function as []fmt.Arg)
(&mut T) fail_now
pub fn (t &mut T) fail_now()
Purpose
Method on `&mut T`: fail now.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
(&mut T) fatal
pub fn (t &mut T) fatal(msg &string)
Purpose
Call `fatal` on `&mut T`.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
msg &string- message (borrowed; caller keeps it; type &string)
(&mut T) fatalf
pub fn (t &mut T) fatalf(f string, args <-> fmt.Arg)
Purpose
Call `fatalf` on `&mut T`.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
f string- callback or format string (string)
args <-> fmt.Arg- variadic fmt.Arg (seen inside the function as []fmt.Arg)
(&mut T) skip_now
pub fn (t &mut T) skip_now()
Purpose
Method on `&mut T`: skip now.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
(&mut T) skip
pub fn (t &mut T) skip(msg &string)
Purpose
Call `skip` on `&mut T`.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
msg &string- message (borrowed; caller keeps it; type &string)
(&mut T) skipf
pub fn (t &mut T) skipf(f string, args <-> fmt.Arg)
Purpose
Call `skipf` on `&mut T`.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
f string- callback or format string (string)
args <-> fmt.Arg- variadic fmt.Arg (seen inside the function as []fmt.Arg)
(&mut T) cleanup
pub fn (t &mut T) cleanup(f fn())
Purpose
Call `cleanup` on `&mut T`.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
f fn()- byte callback: argument is 0..255, return whether it matches
(&mut T) run_cleanup
pub fn (t &mut T) run_cleanup()
Purpose
LIFO. The language test harness does not call this; tests must invoke it.
Parameters
t &mut T- receiver &mut T (exclusive borrow)
(T) run
pub fn (t T) run(name string) T
Purpose
Call `run` on `T`.
Parameters
t T- receiver T (value receiver)
name string- name (string)
Returns
T — a value of this type
short
Purpose
short; returns bool.
Parameters
none
Returns
bool — true or false
struct B
pub struct B {
pub n int
pub failed int
pub name string
}
Purpose
Public struct `B`.
Parameters
n int- count, length, or limit
failed int- field (int)
name string- name
b
Purpose
b; returns B.
Parameters
n int- count, length, or limit (int)
Returns
B — a value of this type
(&mut B) fail
Purpose
Call `fail` on `&mut B`.
Parameters
b &mut B- receiver &mut B (exclusive borrow)
(&mut B) errorf
pub fn (b &mut B) errorf(f string, args <-> fmt.Arg)
Purpose
Method on `&mut B`: build an error from a format string.
Parameters
b &mut B- receiver &mut B (exclusive borrow)
f string- callback or format string (string)
args <-> fmt.Arg- variadic fmt.Arg (seen inside the function as []fmt.Arg)
(&mut B) fatalf
pub fn (b &mut B) fatalf(f string, args <-> fmt.Arg)
Purpose
Call `fatalf` on `&mut B`.
Parameters
b &mut B- receiver &mut B (exclusive borrow)
f string- callback or format string (string)
args <-> fmt.Arg- variadic fmt.Arg (seen inside the function as []fmt.Arg)
(B) failed
pub fn (b B) failed() bool
Purpose
Call `failed` on `B`.
Parameters
b B- receiver B (value receiver)
Returns
bool — true or false