Skip to content

cupertino-files / RawMessage

Class: RawMessage

Defined in: src/base/protobuf.ts:66

Constructors

Constructor

new RawMessage(): RawMessage

Returns

RawMessage

Properties

fields

fields: RawField[] = []

Defined in: src/base/protobuf.ts:67

Accessors

isDirty

Get Signature

get isDirty(): boolean

Defined in: src/base/protobuf.ts:153

Returns

boolean

Methods

addMessage()

addMessage(no, m): void

Defined in: src/base/protobuf.ts:415

Parameters

no

number

m

RawMessage

Returns

void


byteLength()

byteLength(): number

Defined in: src/base/protobuf.ts:199

Serialized length without materializing (cheap when clean).

Returns

number


clone()

clone(): RawMessage

Defined in: src/base/protobuf.ts:487

Returns

RawMessage


fieldWire()

fieldWire(no): WireType | undefined

Defined in: src/base/protobuf.ts:217

Wire type of the last occurrence of a field, if present.

Parameters

no

number

Returns

WireType | undefined


getBool()

getBool(no): boolean | undefined

Defined in: src/base/protobuf.ts:235

Parameters

no

number

Returns

boolean | undefined


getBytes()

getBytes(no): Uint8Array<ArrayBufferLike> | undefined

Defined in: src/base/protobuf.ts:240

Parameters

no

number

Returns

Uint8Array<ArrayBufferLike> | undefined


getDouble()

getDouble(no): number | undefined

Defined in: src/base/protobuf.ts:302

Parameters

no

number

Returns

number | undefined


getFixed32()

getFixed32(no): number | undefined

Defined in: src/base/protobuf.ts:286

Parameters

no

number

Returns

number | undefined


getFloat()

getFloat(no): number | undefined

Defined in: src/base/protobuf.ts:294

Parameters

no

number

Returns

number | undefined


getFloats()

getFloats(no): number[]

Defined in: src/base/protobuf.ts:314

Repeated float field, packed (length-delimited run of 4-byte words) or unpacked (repeated fixed32 keys), or a mix. Returns values in order.

Parameters

no

number

Returns

number[]


getMessage()

getMessage(no): RawMessage | undefined

Defined in: src/base/protobuf.ts:263

Parse (and cache) a length-delimited field as a submessage.

Parameters

no

number

Returns

RawMessage | undefined


getMessages()

getMessages(no): RawMessage[]

Defined in: src/base/protobuf.ts:269

Parameters

no

number

Returns

RawMessage[]


getPackedVarints()

getPackedVarints(no): bigint[]

Defined in: src/base/protobuf.ts:355

Repeated varint field that may be encoded packed (length-delimited), unpacked (repeated varint keys), or a mix. Returns values in order.

Parameters

no

number

Returns

bigint[]


getString()

getString(no): string | undefined

Defined in: src/base/protobuf.ts:247

Parameters

no

number

Returns

string | undefined


getStrings()

getStrings(no): string[]

Defined in: src/base/protobuf.ts:252

Parameters

no

number

Returns

string[]


getUint()

getUint(no): number | undefined

Defined in: src/base/protobuf.ts:228

Parameters

no

number

Returns

number | undefined


getVarint()

getVarint(no): bigint | undefined

Defined in: src/base/protobuf.ts:221

Parameters

no

number

Returns

bigint | undefined


has()

has(no): boolean

Defined in: src/base/protobuf.ts:212

Parameters

no

number

Returns

boolean


markDirty()

markDirty(): void

Defined in: src/base/protobuf.ts:157

Returns

void


remove()

remove(no): void

Defined in: src/base/protobuf.ts:379

Remove every occurrence of a field.

Parameters

no

number

Returns

void


setBool()

setBool(no, v): void

Defined in: src/base/protobuf.ts:399

Parameters

no

number

v

boolean

Returns

void


setBytes()

setBytes(no, b): void

Defined in: src/base/protobuf.ts:403

Parameters

no

number

b

Uint8Array

Returns

void


setDouble()

setDouble(no, v): void

Defined in: src/base/protobuf.ts:435

Parameters

no

number

v

number

Returns

void


setFixed32()

setFixed32(no, v): void

Defined in: src/base/protobuf.ts:441

Parameters

no

number

v

number

Returns

void


setFloat()

setFloat(no, v): void

Defined in: src/base/protobuf.ts:429

Parameters

no

number

v

number

Returns

void


setFloats()

setFloats(no, values): void

Defined in: src/base/protobuf.ts:338

Replace all occurrences of a repeated float field, preserving position.

Written unpacked (one fixed32 key per value), which is the proto2 default and what Apple emits for e.g. StrokePatternArchive.pattern.

Parameters

no

number

values

readonly number[]

Returns

void


setMessage()

setMessage(no, m): void

Defined in: src/base/protobuf.ts:411

Parameters

no

number

m

RawMessage

Returns

void


setMessages()

setMessages(no, msgs): void

Defined in: src/base/protobuf.ts:475

Replace all occurrences of a repeated message field, preserving position.

Parameters

no

number

msgs

readonly RawMessage[]

Returns

void


setPackedVarints()

setPackedVarints(no, values): void

Defined in: src/base/protobuf.ts:468

Write a repeated varint field packed (replacing all occurrences).

Parameters

no

number

values

readonly (number | bigint)[]

Returns

void


setString()

setString(no, s): void

Defined in: src/base/protobuf.ts:407

Parameters

no

number

s

string

Returns

void


setVarint()

setVarint(no, v): void

Defined in: src/base/protobuf.ts:395

Parameters

no

number

v

number | bigint

Returns

void


setVarints()

setVarints(no, values): void

Defined in: src/base/protobuf.ts:454

Replace all occurrences of a repeated varint field, unpacked.

The proto2 default, and what Apple emits for the parallel arrays in e.g. TST.FilterSetArchivesetPackedVarints writes the other encoding, which readers accept but which no Apple file uses there.

Parameters

no

number

values

readonly (number | bigint)[]

Returns

void


toBytes()

toBytes(): Uint8Array

Defined in: src/base/protobuf.ts:167

Returns

Uint8Array


create()

static create(): RawMessage

Defined in: src/base/protobuf.ts:147

Create an empty message (dirty by construction).

Returns

RawMessage


parse()

static parse(bytes): RawMessage

Defined in: src/base/protobuf.ts:73

Parameters

bytes

Uint8Array

Returns

RawMessage

MIT licensed. Independently made — not by Apple in California. Not affiliated with or endorsed by Apple Inc.