# ropes

Theme:

- Index

Search:
Group by:
Source Edit

# Imports

pathutils

# Types

    FormatStr = string

  Source Edit

    Rope = string

  Source Edit

# Procs

    proc `%`(frmt: static[FormatStr]; args: openArray[Rope]): Rope

  Source Edit

    proc equalsFile(r: Rope; filename: AbsoluteFile): bool {....raises: [IOError],
        tags: [ReadIOEffect], forbids: [].}

  returns true if the contents of the file `f` equal `r`. If `f` does not exist, false is returned. Source Edit

    proc equalsFile(s: Rope; f: File): bool {....raises: [IOError],
        tags: [ReadIOEffect], forbids: [].}

  returns true if the contents of the file `f` equal `r`. Source Edit

    proc freeze(r: Rope) {.inline, ...raises: [], tags: [], forbids: [].}

  Source Edit

    proc newRopeAppender(cap = 80): string {.inline, ...raises: [], tags: [],
        forbids: [].}

  Source Edit

    proc prepend(a: var Rope; b: string) {....raises: [], tags: [], forbids: [].}

  Source Edit

    proc resetRopeCache() {....raises: [], tags: [], forbids: [].}

  Source Edit

    proc rope(f: BiggestFloat): Rope {....raises: [], tags: [], forbids: [].}

  Converts a float to a rope. Source Edit

    proc rope(i: BiggestInt): Rope {....raises: [], tags: [], forbids: [].}

  Converts an int to a rope. Source Edit

    proc runtimeFormat(frmt: FormatStr; args: openArray[Rope]): Rope {....raises: [],
        tags: [], forbids: [].}

  Source Edit

    proc writeRope(f: File; r: Rope) {....raises: [IOError], tags: [WriteIOEffect],
                                       forbids: [].}

  writes a rope to a file. Source Edit

    proc writeRope(head: Rope; filename: AbsoluteFile): bool {....raises: [IOError],
        tags: [WriteIOEffect], forbids: [].}

  Source Edit

# Templates

    template addf(c: var Rope; frmt: FormatStr; args: openArray[Rope])

  shortcut for `add(c, frmt % args)`. Source Edit

    template rope(s: string): string

  Source Edit