Merge pull request #265 from gibbz00/error_codes

Add missing error codes, use doc comments for all of them.

Author: Marwes

src/error_codes.rs

@@ -2,35 +2,53 @@
 //! There are other error codes that are defined in the
 //! [JSON RPC specification](https://www.jsonrpc.org/specification#error_object).
 
-// This is the start range of LSP reserved error codes.
-// It doesn't denote a real error code.
-//
-// @since 3.16.0
+/// Defined in the LSP specification but in the range reserved for JSON-RPC error codes,
+/// namely the -32099 to -32000 "Reserved for implementation-defined server-errors." range.
+/// The code has, nonetheless, been left in this range for backwards compatibility reasons.
+pub const SERVER_NOT_INITIALIZED: i64 = -32002;
+
+/// Defined in the LSP specification but in the range reserved for JSON-RPC error codes,
+/// namely the -32099 to -32000 "Reserved for implementation-defined server-errors." range.
+/// The code has, nonetheless, left in this range for backwards compatibility reasons.
+pub const UNKNOWN_ERROR_CODE: i64 = -32001;
+
+/// This is the start range of LSP reserved error codes.
+/// It doesn't denote a real error code.
+///
+/// @since 3.16.0
 pub const LSP_RESERVED_ERROR_RANGE_START: i64 = -32899;
 
-// The server cancelled the request. This error code should
-// only be used for requests that explicitly support being
-// server cancellable.
-//
-// @since 3.17.0
+/// A request failed but it was syntactically correct, e.g the
+/// method name was known and the parameters were valid. The error
+/// message should contain human readable information about why
+/// the request failed.
+///
+/// @since 3.17.0
+pub const REQUEST_FAILED: i64 = -32803;
+
+/// The server cancelled the request. This error code should
+/// only be used for requests that explicitly support being
+/// server cancellable.
+///
+/// @since 3.17.0
 pub const SERVER_CANCELLED: i64 = -32802;
 
-// The server detected that the content of a document got
-// modified outside normal conditions. A server should
-// NOT send this error code if it detects a content change
-// in it unprocessed messages. The result even computed
-// on an older state might still be useful for the client.
-//
-// If a client decides that a result is not of any use anymore
-// the client should cancel the request.
+/// The server detected that the content of a document got
+/// modified outside normal conditions. A server should
+/// NOT send this error code if it detects a content change
+/// in it unprocessed messages. The result even computed
+/// on an older state might still be useful for the client.
+///
+/// If a client decides that a result is not of any use anymore
+/// the client should cancel the request.
 pub const CONTENT_MODIFIED: i64 = -32801;
 
-// The client has canceled a request and a server as detected
-// the cancel.
+/// The client has canceled a request and a server as detected
+/// the cancel.
 pub const REQUEST_CANCELLED: i64 = -32800;
 
-// This is the end range of LSP reserved error codes.
-// It doesn't denote a real error code.
-//
-// @since 3.16.0
+/// This is the end range of LSP reserved error codes.
+/// It doesn't denote a real error code.
+///
+/// @since 3.16.0
 pub const LSP_RESERVED_ERROR_RANGE_END: i64 = -32800;