Authors: Jean-Sébastien Pédron (js.pedron@meetic-corp.com).
jid() = {jid, Orig_Jid, Prepd_Node, Prepd_Domain, Prepd_Resource}
Represents a JID.
jid()
is an internal type and the structure documented
herein may be changed without notice. Please use only the
accessors exported by this module to get each component of a JID.
Prepd_Node
is set to the value of Node
passed through the
NODEPREP stringprep profile.
Prepd_Domain
is set to the value of Domain
passed through the
NAMEPREP stringprep profile.
Prepd_Resource
is set to the value of Resource
passed through the
RESOURCEPREP stringprep profile.
bare/1 | Convert a full JID to its bare version. |
bare_compare/2 | Compare bare JIDs. |
bare_to_binary/1 | Stringify a bare JID. |
bare_to_binary/2 | Stringify a full JID. |
bare_to_list/1 | Stringify a bare JID. |
bare_to_list/2 | Stringify a full JID. |
binary_split/2 | |
compare/2 | Compare full JIDs. |
compare_domains/2 | Compare JID's domain. |
domain/1 | Return the domain part of a JID. |
domain_as_list/1 | Return the domain part of a JID as a list. |
full/2 | Convert a bare JID to its full version. |
full_compare/2 | Compare full JIDs. |
is_jid/1 | Tell if the argument is a JID. |
make/0 | Create a blank JID. |
make/1 | Create a bare JID. |
make/2 | Create a bare JID. |
make/3 | Create a full JID. |
node/1 | Return the node part of a JID. |
node_as_list/1 | Return the node part of a JID as a list. |
parse/1 | Parse a string and create a full JID. |
prep_bare_to_binary/1 | Stringify a bare JID with STRINGPREP profiles applied. |
prep_bare_to_list/1 | Stringify a bare JID with STRINGPREP profiles applied. |
prep_domain/1 | Return the domain part of a JID with NAMEPREP profile applied. |
prep_domain_as_list/1 | Return the domain part of a JID as a list with NAMEPREP profile applied. |
prep_node/1 | Return the node part of a JID with NODEPREP profile applied. |
prep_node_as_list/1 | Return the node part of a JID as a list with NODEPREP profile applied. |
prep_resource/1 | Return the resource part of a JID with RESOURCEPREP profile applied. |
prep_resource_as_list/1 | Return the domain part of a JID as a list with RESOURCEPREP profile applied. |
prep_to_binary/1 | Stringify a full JID with STRINGPREP profiles applied. |
prep_to_list/1 | Stringify a full JID with STRINGPREP profiles applied. |
resource/1 | Return the resource part of a JID. |
resource_as_list/1 | Return the resource part of a JID as a list. |
to_binary/1 | Stringify a full JID. |
to_binary/2 | Stringify a bare JID. |
to_binary/3 | Stringify a full JID. |
to_list/1 | Stringify a full JID. |
to_list/2 | Stringify a bare JID. |
to_list/3 | Stringify a full JID. |
to_lower/1 |
Convert a full JID to its bare version.
Compare bare JIDs.
bare_to_binary(Jid) -> String
Stringify a bare JID.
bare_to_binary(Node, Domain) -> String
Stringify a full JID.
bare_to_list(Jid) -> String
Stringify a bare JID.
bare_to_list(Node, Domain) -> String
Stringify a full JID.
binary_split(B, C) -> any()
Compare full JIDs. This function is identical to full_compare/2.
Compare JID's domain.
domain(Jid) -> Domain | undefined
Return the domain part of a JID.
domain_as_list(Jid) -> Domain | undefined
Return the domain part of a JID as a list.
full(Jid::Bare_Jid, Resource) -> Jid
throws {jid, convert, too_long, {resource, Resource}} | {jid, convert, invalid, {resource, Resource}}
Convert a bare JID to its full version.
Compare full JIDs.
is_jid(Jid) -> bool()
Tell if the argument is a JID.
You should probably use theIS_JID(Jid)
guard expression.
make() -> Jid
Create a blank JID.
make(Domain) -> Bare_Jid
throws {jid, make, too_long, {domain, Domain}} | {jid, make, invalid, {domain, Domain}}
Create a bare JID.
make(Node, Domain) -> Bare_Jid
throws {jid, make, too_long, {domain, Domain}} | {jid, make, invalid, {domain, Domain}} | {jid, make, too_long, {node, Node}} | {jid, make, invalid, {node, Node}}
Create a bare JID.
make(Node, Domain, Resource) -> Jid
Create a full JID.
node(Jid) -> Node | undefined
Return the node part of a JID.
node_as_list(Jid) -> Node | undefined
Return the node part of a JID as a list.
parse(String) -> Jid
throws {jid, parse, Reason, {jid, String}}
Parse a string and create a full JID.
prep_bare_to_binary(Jid) -> String
Stringify a bare JID with STRINGPREP profiles applied.
prep_bare_to_list(Jid) -> String
Stringify a bare JID with STRINGPREP profiles applied.
prep_domain(Jid) -> Domain | undefined
Return the domain part of a JID with NAMEPREP profile applied.
prep_domain_as_list(Jid) -> Domain | undefined
Return the domain part of a JID as a list with NAMEPREP profile applied.
prep_node(Jid) -> Node | undefined
Return the node part of a JID with NODEPREP profile applied.
prep_node_as_list(Jid) -> Node | undefined
Return the node part of a JID as a list with NODEPREP profile applied.
prep_resource(Jid) -> Resource | undefined
Return the resource part of a JID with RESOURCEPREP profile applied.
prep_resource_as_list(Jid) -> Resource | undefined
Return the domain part of a JID as a list with RESOURCEPREP profile applied.
prep_to_binary(Jid) -> String
Stringify a full JID with STRINGPREP profiles applied.
prep_to_list(Jid) -> String
Stringify a full JID with STRINGPREP profiles applied.
resource(Jid) -> Resource | undefined
Return the resource part of a JID.
resource_as_list(Jid) -> Resource | undefined
Return the resource part of a JID as a list.
to_binary(Jid) -> String
Stringify a full JID.
to_binary(Node, Domain) -> String
Stringify a bare JID.
to_binary(Node, Domain, Resource) -> String
Stringify a full JID.
to_list(Jid) -> String
Stringify a full JID.
to_list(Node, Domain) -> String
Stringify a bare JID.
to_list(Node, Domain, Resource) -> String
Stringify a full JID.
to_lower(Jid::jid()) -> {Node::string(), Domain::string(), Resource::string()}
Generated by EDoc, Jan 21 2011, 01:43:51.