Function: erc-match-newlinep

erc-match-newlinep is a byte-compiled function defined in erc-match.el.gz.

Signature

(erc-match-newlinep erc-match-newlinep X)

Documentation

Access slot "newlinep" of erc-match struct X.

Whether narrowed buffer includes trailing newline.

Source Code

;; Defined in /usr/src/emacs/lisp/erc/erc-match.el.gz
(cl-defstruct (erc-match (:constructor erc-match))
  "Base type for text and user matching performed by the \\+`match' module.
Users wishing to perform custom matching should add a constructor that
returns an instance of this type to the hook `erc-match-functions'.  If
the `:predicate' slot's predicate returns non-nil after being called
with its own instance in the narrowed single-message buffer, ERC calls
the `:handler' slot's function with the same instance and with the match
data still intact.  More details in Info node `(erc) Match API'."
  ( predicate (error "Keyword `:predicate' missing") :type function
    :documentation "Called in narrowed buffer with own instance.")
  ( spkr-beg nil :type (or null natnum)
    :documentation "Position of the beginning of speaker's nick, if known.")
  ( spkr-end nil :type (or null natnum)
    :documentation "Position of the end of speaker's nick, if known.")
  ( body-beg (error "Keyword `:body-beg' missing") :type marker
    :documentation "Marker residing at the beginning of the message body.")
  ( sender (error "Keyword `:sender' missing") :type string
    :documentation "The sender's n!u@h.")
  ( nick nil :type (or null string)
    :documentation "The sender's nick if they're a user and not the server.")
  ( command (error "Keyword `:command' missing") :type (or symbol natnum)
    :documentation "Protocol command or numeric, like `PRIVMSG' or 353.")
  ( handler #'ignore :type function
    :documentation "Called on `:predicate' match with own instance.")
  ( newlinep nil :type boolean
    :documentation "Whether narrowed buffer includes trailing newline."))