Skip to content

Latest commit

 

History

History
38 lines (33 loc) · 5.21 KB

Jcd.SRecord.md

File metadata and controls

38 lines (33 loc) · 5.21 KB

Jcd.SRecord Namespace

Provides support for reading and writing s-record files.

Classes
SRecordData Represents a single SRecordData entry in an s-record file. This is an immutable type. To edit the contents, create a new one with the altered data buffer, address, and/or type.
SRecordDataFormatter Implements the formatting logic required to emit a single SRecordData with consistent hex value casing.
SRecordDataParser Implements parsing of the textual SRecordData format into its binary representation.
SRecordDataStatistics Represents summary information about the contents of an any collection of SRecordData.
SRecordDataType.Flexible Provides a collection and lookup mechanism for instances of SRecordDataType configured to accept a flexible number of data bytes per record. The exact amount allowed varies per type and is 254 bytes minus the address length in bytes, for S0, S1, S2, S3, and S4. NOTE: S4 types always require special, implementation defined, handling.
SRecordDataType.Strict Provides a collection and lookup mechanism for instances of SRecordDataType configured to accept a maximum of 32 data bytes per record for S0, S1, S2, S3, and S4 record types. NOTE: S4 types always require special, implementation defined, handling.
SRecordDocument Represents an SRecordData document that contains all the records that were read.
SRecordElement Represents a single line in an SRecordDocument.
SRecordElementFormattedEventArgs Provides context for the SRecordElementFormatter.Formatted event.
SRecordElementFormatter Encapsulates the logic necessary to format an SRecordElement as a line of text.
SRecordElementFormattingEventArgs Provides context for the SRecordElementFormatter.Formatting event.
SRecordElementParsedEventArgs Provides context for the SRecordElementParser.Parsed event.
SRecordElementParser Provides a default mechanism for parsing a line of text into an SRecordElement.
SRecordElementParsingEventArgs Provides context for the SRecordElementParser.Parsing event.
SRecordElementReader A forward only SRecordElement stream/string reader. This class always disposes its TextReader when disposed.
SRecordElementStatistics Represents a set of statistics about a set of SRecordElement instances.
SRecordElementWriter Provides the logic necessary to write SRecordElements to a Stream or TextWriter.
Structs
SRecordDataType Represents the information required to identify and process various types of SRecords as documented here
SRecordElementFormatter.Options Represents the formatting options desired when writing SRecordElement contents to an SRecordElementWriter.
SRecordElementType Defines a set of flags that describe the results of parsing a line of text from an SRecordDocument
Interfaces
ISRecordDataFormatter Defines the operations necessary to support formatting an SRecordData into text.
ISRecordDataParser Defines the operations necessary in order to support parsing text into SRecordData instances.
ISRecordElementFormatter Defines the operations necessary to support formatting SRecordElements to lines of text.
ISRecordElementParser Defines the operations necessary to parse SRecordElements from text.