IBuildEventArgsReaderNotifications Interface

Definition

An interface for notifications from BuildEventArgsReader

public interface class IBuildEventArgsReaderNotifications
public interface IBuildEventArgsReaderNotifications
type IBuildEventArgsReaderNotifications = interface
Public Interface IBuildEventArgsReaderNotifications
Derived

Events

ArchiveFileEncountered

An event that allows the caller to be notified when an embedded file is encountered in the binary log. When subscriber is OK with greedy reading entire content of the file and is interested only in the individual strings (e.g. for sensitive data redaction purposes), it can simplify subscribing to this event, by using handler with same signature as handler for StringReadDone and wrapping it via ToArchiveFileHandler(Action<StringReadEventArgs>) extension.

RecoverableReadError

Receives recoverable errors during reading. Communicates type of the error, kind of the record that encountered the error and the message detailing the error. In case of UnknownEventData this is raised before returning the structured representation of a build event that has some extra unknown data in the binlog. In case of other error types this event is raised and the offending build event is skipped and not returned.

StringReadDone

An event that allows the subscriber to be notified when a string is read from the binary log. Subscriber may adjust the string by setting StringToBeUsed property. The passed event arg can be reused and should not be stored.

Applies to