Xgit v0.7.2 Xgit.PersonIdent View Source
A combination of a person identity and time in git.
Link to this section Summary
Types
The tuple of name, email, time, and time zone that specifies who wrote or committed something.
Time zone offset in minutes +/- from GMT.
Functions
Formats a timezone offset.
Parse a name line (e.g. author, committer, tagger) into a PersonIdent
struct.
Sanitize the given string for use in an identity and append to output.
Formats the person identity for git storage.
Returns true
if the struct is a valid PersonIdent
.
Link to this section Types
The tuple of name, email, time, and time zone that specifies who wrote or committed something.
Struct Members
:name
: (string) human-readable name of the author or committer:email
: (string) e-mail address for this person:when
: (integer) time in the Unix epoch in milliseconds:tz_offset
: (integer) time zone offset from GMT in minutes
Time zone offset in minutes +/- from GMT.
Link to this section Functions
Formats a timezone offset.
Parse a name line (e.g. author, committer, tagger) into a PersonIdent
struct.
Parameters
b
should be a charlist of an "author" or "committer" line pointing to the
character after the header name and space.
Return Value
Returns a PersonIdent
struct or nil
if the charlist did not point to a
properly-formatted identity.
Sanitize the given string for use in an identity and append to output.
Trims whitespace from both ends and special characters \n < >
that
interfere with parsing; appends all other characters to the output.
Formats the person identity for git storage.
Returns true
if the struct is a valid PersonIdent
.