API documentation

URNs

CitableBase.Urn — Type

Unique identifiers expressible in the syntax of the IETF's URN specification.

source
CitableBase.components — Function
components(uString)

Splits a string on colons (separator for top-level components of URNs).

Examples

julia> components("urn:cts:greekLit:tlg0012.tlg001.msA:1.1")
source
components(u)

Splits a URN's string representation into top-level components.

source
CitableBase.parts — Function
parts(componentString)

Splits a string on periods (seprator for parts within components of URNs).

Examples

julia> parts("tlg0012.tlg001.msA")
source

Citable resources

CitableBase.urn — Function

Delegate urn to specific functions based on type's citable trait value.

urn(x)
source

It is an error to invoke the urn function on material that is not citable.

urn(_, x)
source
CitableBase.label — Function

Delegate label to specific functions based on type's citable trait value.

label(x)
source

It is an error to invoke the label function on material that is not citable.

label(_, x)
source

URN comparison

CitableBase.urnequals — Function

For subtypes of Urn, implement urnequals concretely.

urnequals(u1, u2)
source

URN-comparable objects must implement urnequals.

urnequals(x, y)
source

CEX serialization

CitableBase.cextrait — Function

The default value of CexTrait is NotCexSerializable.

cextrait(_)
source

Subtypes of Citable are CexSerializable.

cextrait(_)
source
CitableBase.cex — Function

Delegate cex to specific functions based on type's cextrait value.

cex(x; delimiter)
source

It is an error to invoke the cex function on material that is not CEX serializable.

cex(, x; delimiter)
source
CitableBase.fromcex — Function

Dispatch fromcex on cextrait of T to instantiate an object of type T from CEX-formatted data cexsrc.

fromcex(cexsrc, T; delimiter, configuration, strict)
source

Implement fromcex using first string parameter for a file name.

fromcex(fname, T, freader; delimiter, configuration, strict)
source

Implement fromcex using first string parameter for a URL.

fromcex(url, T, ureader; delimiter, configuration, strict)
source

Implement fromcex using first string parameter for raw string data.

fromcex(
    cexsrc,
    T,
    freader;
    delimiter,
    configuration,
    strict
)
source

It is an error to invoke the fromcex function on material that is not CEX serializable.

fromcex(, cex, T; delimiter, configuration, strict)
source

It is an error invoke fromcex function with an unimplemented trait value.

fromcex(
    traitvalue,
    cexsrc,
    T;
    delimiter,
    configuration,
    strict
)
source

Citable collections