palm-pdb
    Preparing search index...

    Class RecordAttrs

    Record attribute flags in PDB files.

    In the DLP protocol, we use one byte to store record attribute flags and another byte to store the record category. However, in PDB files, we use a single byte is used to store both attribute flags and the record category.

    This presents a problem: there are 5 record attributes (namely delete, dirty, busy, secret, and archive), leaving 3 bits unused, but we need 4 bits to store the record category. So the lowest 4 bits are overloaded, but the exactly how differs among existing open source implementations:

    In pilot-link:

    • Upper 4 bits store the first 4 record attributes (delete, dirty, busy, secret)
    • Lower 4 bits store the record category; there's no archive bit

    In ColdSync:

    • If the record is busy, bit 5 stores the archive flag and the lowest 3 bits are unused.
    • If the record is not busy, the lowest 4 bits store the category.

    In the Palm::PDB Perl module:

    • If the record is deleted or busy, bit 5 stores the archive flag and the lowest 3 bits are unused.
    • If the record is neither deleted or busy, the lowest 4 bits store the category.

    Here we've chosen to follow the Palm::PDB Perl module's implementation, as it is the most flexible.

    References:

    Hierarchy

    • {
          value: number;
          wrapperType: new () => SerializableWrapper<number>;
          assignJSON(jsonValue: number | { [key: string | symbol]: number }): void;
          deserialize(buffer: Buffer, opts?: DeserializeOptions): number;
          getSerializedLength(opts?: SerializeOptions): number;
          serialize(opts?: SerializeOptions): Buffer;
          toJSON(): any;
      }
      • RecordAttrs
    Index

    Constructors

    constructor

    Properties

    busy delete dirty secret value wrapperType

    Accessors

    archive category

    Methods

    assignJSON deserialize getSerializedLength serialize toJSON from of with

    Constructors

    • Returns RecordAttrs

    Properties

    busy: boolean = false

    Record currently in use.

    This bit may also indicate the record has been deleted -- see comments in https://github.com/dwery/coldsync/blob/master/include/pdb.h .

    delete: boolean = false

    Record has been deleted.

    dirty: boolean = false

    Record has been modified.

    secret: boolean = false

    "Secret" record - password protected.

    value: number
    wrapperType: new () => SerializableWrapper<number>

    Accessors

    Methods

    • Parameters

      • jsonValue: number | { [key: string | symbol]: number }

      Returns void

    • Parameters

      • buffer: Buffer
      • Optionalopts: DeserializeOptions

      Returns number

    • Parameters

      • Optionalopts: SerializeOptions

      Returns number

    • Parameters

      • Optionalopts: SerializeOptions

      Returns Buffer

    • Returns any

    • Type Parameters

      • T extends Serializable

      Parameters

      • this: new () => T
      • buffer: Buffer
      • Optionalopts: DeserializeOptions

      Returns T

    • Create a new instance of this wrapper class from a raw value.

      Type Parameters

      • SBitmaskT extends SBitmask

      Parameters

      Returns SBitmaskT

    • Returns an SBitmask class that serializes using the provided SerializableWrapper.

      Parameters

      • wrapperType: new () => SerializableWrapper<number>

      Returns {
          from<T extends Serializable>(
              this: new () => T,
              buffer: Buffer,
              opts?: DeserializeOptions,
          ): T;
          of<SBitmaskT extends SBitmask>(
              this: new () => SBitmaskT,
              value: number,
          ): SBitmaskT;
          of(
              wrapperType: new () => SerializableWrapper<number>,
          ): { new (): { wrapperType: new () => SerializableWrapper<number>; value: number; deserialize(buffer: Buffer<ArrayBufferLike>, opts?: DeserializeOptions | undefined): number; serialize(opts?: SerializeOptions | undefined): Buffer<...>; getSerializedLength(opts?: SerializeOptions | undefined): number; toJSON(): any; ass...;
          with<T extends SBitmask>(this: new () => T, props?: Partial<T>): T;
          new (): {
              value: number;
              wrapperType: new () => SerializableWrapper<number>;
              assignJSON(jsonValue: number | { [key: string | symbol]: number }): void;
              deserialize(buffer: Buffer, opts?: DeserializeOptions): number;
              getSerializedLength(opts?: SerializeOptions): number;
              serialize(opts?: SerializeOptions): Buffer;
              toJSON(): any;
          };
      }

        • new (): {
              value: number;
              wrapperType: new () => SerializableWrapper<number>;
              assignJSON(jsonValue: number | { [key: string | symbol]: number }): void;
              deserialize(buffer: Buffer, opts?: DeserializeOptions): number;
              getSerializedLength(opts?: SerializeOptions): number;
              serialize(opts?: SerializeOptions): Buffer;
              toJSON(): any;
          }

        • Returns {
              value: number;
              wrapperType: new () => SerializableWrapper<number>;
              assignJSON(jsonValue: number | { [key: string | symbol]: number }): void;
              deserialize(buffer: Buffer, opts?: DeserializeOptions): number;
              getSerializedLength(opts?: SerializeOptions): number;
              serialize(opts?: SerializeOptions): Buffer;
              toJSON(): any;
          }

      • from: function
        • from<T extends Serializable>(
              this: new () => T,
              buffer: Buffer,
              opts?: DeserializeOptions,
          ): T

          Type Parameters

          • T extends Serializable

          Parameters

          • this: new () => T
          • buffer: Buffer
          • Optionalopts: DeserializeOptions

          Returns T

      • of: function
        • of<SBitmaskT extends SBitmask>(
              this: new () => SBitmaskT,
              value: number,
          ): SBitmaskT

          Create a new instance of this wrapper class from a raw value.

          Type Parameters

          • SBitmaskT extends SBitmask

          Parameters

          Returns SBitmaskT

        • of(
              wrapperType: new () => SerializableWrapper<number>,
          ): { new (): { wrapperType: new () => SerializableWrapper<number>; value: number; deserialize(buffer: Buffer<ArrayBufferLike>, opts?: DeserializeOptions | undefined): number; serialize(opts?: SerializeOptions | undefined): Buffer<...>; getSerializedLength(opts?: SerializeOptions | undefined): number; toJSON(): any; ass...

          Returns an SBitmask class that serializes using the provided SerializableWrapper.

          Parameters

          • wrapperType: new () => SerializableWrapper<number>

          Returns { new (): { wrapperType: new () => SerializableWrapper<number>; value: number; deserialize(buffer: Buffer<ArrayBufferLike>, opts?: DeserializeOptions | undefined): number; serialize(opts?: SerializeOptions | undefined): Buffer<...>; getSerializedLength(opts?: SerializeOptions | undefined): number; toJSON(): any; ass...

      • with: function
        • with<T extends SBitmask>(this: new () => T, props?: Partial<T>): T

          Create a new instance with the provided initial properties.

          Type Parameters

          • T extends SBitmask

          Parameters

          • this: new () => T
          • Optionalprops: Partial<T>

          Returns T

    • Create a new instance with the provided initial properties.

      Type Parameters

      • T extends SBitmask

      Parameters

      • this: new () => T
      • Optionalprops: Partial<T>

      Returns T

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods