Categorygithub.com/mqus/go-contentline
modulepackage
1.1.1
Repository: https://github.com/mqus/go-contentline.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
7
Dependents
0
Files
649 SLOC

# README

go-contentline

CircleCI Go v1.9

A Parsing backend for parsing ical/vcard streams to a component-tree, Licensed under the MPL v2.0

It is compliant to RFC 6350 (vCard), 5545 (iCal) and 6868 (Encoding extensions), which are the most recent standards(RFCs) concerning the topic.

See the releases for ready-to-use versions of the library. The version numbering conforms to SemVer.

The Documentation can be found on GoDoc

The implemented tests for the encoding functions need strings.Builder from go1.10 (marked with build tags) but everything else builds with a less recent go version.

# Functions

EscapeParamVal applies the rules specified in RFC6868 to escape newlines,Double-Quotes(") and Circumflex-accents(^) with circumflex-accents.
InitParser initializes the parser by creating a buffered Reader.
NewPropertyUnchecked creates a new Property.
NewPropertyUnchecked creates a new Property, where the property name is not checked for validity.
UnescapeParamVal applies the rules specified in RFC6868 to unescape newlines,Double-Quotes(") and Circumflex-accents(^).
ValidID checks if a string is a valid identifier (iana-token or x-token).

# Structs

Component is the outermost structured part and can include multiple other Components and has Properties.
Parser contains fields describing the state of the parser.
Property is the way to include Values into Components.

# Type aliases

Parameters is a type to represent property parameters as described by RFC6868; RFC5545, Section 3.2 and RFC6350, Section 5.