Merge branch 'doc-strings'
authorAlejandro R Sedeño <asedeno@google.com>
Thu, 4 Apr 2013 19:42:12 +0000 (15:42 -0400)
committerAlejandro R Sedeño <asedeno@google.com>
Thu, 4 Apr 2013 19:42:12 +0000 (15:42 -0400)
Conflicts:
src/common/conditions.lisp
src/wire-protocol/basic-types.lisp

1  2 
src/common/conditions.lisp
src/wire-protocol/basic-types.lisp
src/wire-protocol/compressed-protocol.lisp
src/wire-protocol/wire-packet.lisp

  ;;; Library Internal Errors
  (define-condition bad-mysql-type-spec (mysql-internal-error)
    ((text :initarg :text
-          :reader bad-mysql-type-spec-text)))
+          :reader bad-mysql-type-spec-text))
+   (:documentation "Signaled when we encounter a bad type spec in DEFINE-PACKET."))
  
 +(define-condition invalid-length-encoded-integer (mysql-internal-error)
 +  ((text :initarg :text
 +         :reader invalid-length-encoded-integer-text)))
 +
 +(define-condition unexpected-sequence-id (mysql-internal-error)
 +  ())
 +
  ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  ;;; Exported Errors
  
  
  (define-condition unexpected-packet (mysql-external-error)
    ((payload :initarg :payload
-             :reader unexpected-packet-payload)))
+             :reader unexpected-packet-payload))
+   (:documentation "Signaled when the library encounters an unexpected packet."))
  
  (define-condition value-is-not-decimal (mysql-external-error)
-   ((value :initarg :value)))
+   ((value :initarg :value))
+   (:documentation "Signaled when calling #'WRITE-DECIMAL-TO-STRING with a value that is not a decimal."))
 -
        ((= n #xfe)
         (read-fixed-length-integer 8 stream))
        ;; #xff here is undefined, though it may be an error packet in certain contexts.
 -      ;; asedeno-TODO: signal a useful condition here.
 -      (t (error "bad length-encoded-integer")))))
 +      (t (error (make-condition 'invalid-length-encoded-integer
 +                                :text "Bad length while reading a length-encoded integer."))))))
  
  (defun write-length-encoded-integer (int stream)
+   "Write INT to STREAM as a MySQL Length-Encoded Integer.
+    Assumes INT is non-negative.
+    Signals an error if INT is too big."
+   (assert (not (minusp int)))
    (cond
      ((< int 251)
       (write-byte int stream))
Simple merge