errors: use the documentation as the error message, if available

Author: wfraser

generator/rust.stoneg.py

@@ -922,7 +922,54 @@ def _impl_error(self, typ):
  u'fmt',
  [u'&self', u'f: &mut ::std::fmt::Formatter<\'_>'],
  u'::std::fmt::Result'):
- self.emit(u'write!(f, "{:?}", *self)')
+
+ # Find variants that have documentation and use the first line for the Display
+ # representation of the error.
+ doc_variants = []
+ for variant in variants:
+ if variant.doc:
+ line = variant.doc.split('\n')[0]
+ # If the line has doc references, it's not going to make a good display
+ # string, so only include it if it has none:
+ if line == self.process_doc(line, lambda tag, value: ''):
+ doc_variants.append((variant, line))
+ else:
+ # TODO(wfraser): don't reject it outright; see if it has an inner value.
+ # It's pretty common to have no doc, but an inner error type that does.
+ print("bad doc for " + type_name + "::" + variant.name)
+
+ if doc_variants:
+ with self.block(u'match self'):
+ for variant, line in doc_variants:
+ var_exp = u'{}::{}'.format(type_name, self.enum_variant_name(variant))
+ args = ""
+ if self._is_error_type(variant.data_type):
+ # Include the Display representation of the inner error.
+ var_exp += u'(inner)'
+ if line.endswith(u'.'):
+ line = line[:-1]
+ line += u': {}'
+ args = u'inner'
+ elif not ir.is_void_type(variant.data_type):
+ # Include the Debug representation of the inner value.
+ var_exp += u'(inner)'
+ if line.endswith('.'):
+ line = line[:-1]
+ line += u': {:?}'
+ args = u'inner'
+
+ if not args:
+ self.emit(u'{} => f.write_str("{}"),'.format(var_exp, line))
+ else:
+ self.emit(u'{} => write!(f, "{}", {}),'.format(
+ var_exp, line, args))
+
+ if not self.is_closed_union(typ) or len(doc_variants) != len(variants):
+ # fall back on the Debug representation
+ self.emit(u'_ => write!(f, "{:?}", *self),')
+ else:
+ # skip the whole match block and just use the Debug representation
+ self.emit(u'write!(f, "{:?}", *self)')
  self.emit()
 
  # Naming Rules

src/generated/account.rs

@@ -290,7 +290,14 @@ impl ::std::error::Error for SetProfilePhotoError {
 
 impl ::std::fmt::Display for SetProfilePhotoError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ SetProfilePhotoError::FileTypeError => f.write_str("File cannot be set as profile photo."),
+ SetProfilePhotoError::FileSizeError => f.write_str("File cannot exceed 10 MB."),
+ SetProfilePhotoError::DimensionError => f.write_str("Image must be larger than 128 x 128."),
+ SetProfilePhotoError::ThumbnailError => f.write_str("Image could not be thumbnailed."),
+ SetProfilePhotoError::TransientError => f.write_str("Temporary infrastructure failure, please retry."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 

src/generated/auth.rs

@@ -127,7 +127,11 @@ impl ::std::error::Error for AccessError {
 
 impl ::std::fmt::Display for AccessError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ AccessError::InvalidAccountType(inner) => write!(f, "Current account type cannot access the resource: {}", inner),
+ AccessError::PaperAccessDenied(inner) => write!(f, "Current account cannot access Paper: {}", inner),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -272,7 +276,16 @@ impl ::std::error::Error for AuthError {
 
 impl ::std::fmt::Display for AuthError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ AuthError::InvalidAccessToken => f.write_str("The access token is invalid."),
+ AuthError::InvalidSelectUser => f.write_str("The user specified in 'Dropbox-API-Select-User' is no longer on the team."),
+ AuthError::InvalidSelectAdmin => f.write_str("The user specified in 'Dropbox-API-Select-Admin' is not a Dropbox Business team admin."),
+ AuthError::UserSuspended => f.write_str("The user has been suspended."),
+ AuthError::ExpiredAccessToken => f.write_str("The access token has expired."),
+ AuthError::MissingScope(inner) => write!(f, "The access token does not have the required scope to access the route: {:?}", inner),
+ AuthError::RouteAccessDenied => f.write_str("The route is not available to public."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -353,7 +366,11 @@ impl ::std::error::Error for InvalidAccountTypeError {
 
 impl ::std::fmt::Display for InvalidAccountTypeError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ InvalidAccountTypeError::Endpoint => f.write_str("Current account type doesn't have permission to access this route endpoint."),
+ InvalidAccountTypeError::Feature => f.write_str("Current account type doesn't have permission to access this feature."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -434,7 +451,11 @@ impl ::std::error::Error for PaperAccessError {
 
 impl ::std::fmt::Display for PaperAccessError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ PaperAccessError::PaperDisabled => f.write_str("Paper is disabled."),
+ PaperAccessError::NotPaperUser => f.write_str("The provided user has not used Paper yet."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -799,7 +820,11 @@ impl ::std::error::Error for TokenFromOAuth1Error {
 
 impl ::std::fmt::Display for TokenFromOAuth1Error {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ TokenFromOAuth1Error::InvalidOauth1TokenInfo => f.write_str("Part or all of the OAuth 1.0 access token info is invalid."),
+ TokenFromOAuth1Error::AppIdMismatch => f.write_str("The authorized app does not match the app associated with the supplied access token."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 

src/generated/common.rs

@@ -199,7 +199,11 @@ impl ::std::error::Error for PathRootError {
 
 impl ::std::fmt::Display for PathRootError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ PathRootError::InvalidRoot(inner) => write!(f, "The root namespace id in Dropbox-API-Path-Root header is not valid. The value of this error is use's latest root info: {:?}", inner),
+ PathRootError::NoPermission => f.write_str("You don't have permission to access the namespace id in Dropbox-API-Path-Root header."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 

src/generated/contacts.rs

@@ -194,7 +194,10 @@ impl ::std::error::Error for DeleteManualContactsError {
 
 impl ::std::fmt::Display for DeleteManualContactsError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ DeleteManualContactsError::ContactsNotFound(inner) => write!(f, "Can't delete contacts from this list. Make sure the list only has manually added contacts. The deletion was cancelled: {:?}", inner),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 

src/generated/dbx_async.rs

@@ -374,7 +374,11 @@ impl ::std::error::Error for PollError {
 
 impl ::std::fmt::Display for PollError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ PollError::InvalidAsyncJobId => f.write_str("The job ID is invalid."),
+ PollError::InternalError => f.write_str("Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 

src/generated/file_properties.rs

@@ -567,7 +567,16 @@ impl ::std::error::Error for AddPropertiesError {
 
 impl ::std::fmt::Display for AddPropertiesError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ AddPropertiesError::TemplateNotFound(inner) => write!(f, "Template does not exist for the given identifier: {:?}", inner),
+ AddPropertiesError::RestrictedContent => f.write_str("You do not have permission to modify this template."),
+ AddPropertiesError::UnsupportedFolder => f.write_str("This folder cannot be tagged. Tagging folders is not supported for team-owned templates."),
+ AddPropertiesError::PropertyFieldTooLarge => f.write_str("One or more of the supplied property field values is too large."),
+ AddPropertiesError::DoesNotFitTemplate => f.write_str("One or more of the supplied property fields does not conform to the template specifications."),
+ AddPropertiesError::DuplicatePropertyGroups => f.write_str("There are 2 or more property groups referring to the same templates in the input."),
+ AddPropertiesError::PropertyGroupAlreadyExists => f.write_str("A property group associated with this template and file already exists."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -1144,7 +1153,15 @@ impl ::std::error::Error for InvalidPropertyGroupError {
 
 impl ::std::fmt::Display for InvalidPropertyGroupError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ InvalidPropertyGroupError::TemplateNotFound(inner) => write!(f, "Template does not exist for the given identifier: {:?}", inner),
+ InvalidPropertyGroupError::RestrictedContent => f.write_str("You do not have permission to modify this template."),
+ InvalidPropertyGroupError::UnsupportedFolder => f.write_str("This folder cannot be tagged. Tagging folders is not supported for team-owned templates."),
+ InvalidPropertyGroupError::PropertyFieldTooLarge => f.write_str("One or more of the supplied property field values is too large."),
+ InvalidPropertyGroupError::DoesNotFitTemplate => f.write_str("One or more of the supplied property fields does not conform to the template specifications."),
+ InvalidPropertyGroupError::DuplicatePropertyGroups => f.write_str("There are 2 or more property groups referring to the same templates in the input."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -1364,7 +1381,10 @@ impl ::std::error::Error for LookUpPropertiesError {
 
 impl ::std::fmt::Display for LookUpPropertiesError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ LookUpPropertiesError::PropertyGroupNotFound => f.write_str("No property group was found."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -1488,7 +1508,13 @@ impl ::std::error::Error for LookupError {
 
 impl ::std::fmt::Display for LookupError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ LookupError::NotFound => f.write_str("There is nothing at the given path."),
+ LookupError::NotFile => f.write_str("We were expecting a file, but the given path refers to something that isn't a file."),
+ LookupError::NotFolder => f.write_str("We were expecting a folder, but the given path refers to something that isn't a folder."),
+ LookupError::RestrictedContent => f.write_str("The file cannot be transferred because the content is restricted. For example, sometimes there are legal restrictions due to copyright claims."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -1626,7 +1652,15 @@ impl ::std::error::Error for ModifyTemplateError {
 
 impl ::std::fmt::Display for ModifyTemplateError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ ModifyTemplateError::TemplateNotFound(inner) => write!(f, "Template does not exist for the given identifier: {:?}", inner),
+ ModifyTemplateError::RestrictedContent => f.write_str("You do not have permission to modify this template."),
+ ModifyTemplateError::ConflictingPropertyNames => f.write_str("A property field key with that name already exists in the template."),
+ ModifyTemplateError::TooManyProperties => f.write_str("There are too many properties in the changed template. The maximum number of properties per template is 32."),
+ ModifyTemplateError::TooManyTemplates => f.write_str("There are too many templates for the team."),
+ ModifyTemplateError::TemplateAttributeTooLarge => f.write_str("The template name, description or one or more of the property field keys is too large."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -1850,7 +1884,12 @@ impl ::std::error::Error for PropertiesError {
 
 impl ::std::fmt::Display for PropertiesError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ PropertiesError::TemplateNotFound(inner) => write!(f, "Template does not exist for the given identifier: {:?}", inner),
+ PropertiesError::RestrictedContent => f.write_str("You do not have permission to modify this template."),
+ PropertiesError::UnsupportedFolder => f.write_str("This folder cannot be tagged. Tagging folders is not supported for team-owned templates."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -3502,7 +3541,12 @@ impl ::std::error::Error for RemovePropertiesError {
 
 impl ::std::fmt::Display for RemovePropertiesError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ RemovePropertiesError::TemplateNotFound(inner) => write!(f, "Template does not exist for the given identifier: {:?}", inner),
+ RemovePropertiesError::RestrictedContent => f.write_str("You do not have permission to modify this template."),
+ RemovePropertiesError::UnsupportedFolder => f.write_str("This folder cannot be tagged. Tagging folders is not supported for team-owned templates."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -3678,7 +3722,11 @@ impl ::std::error::Error for TemplateError {
 
 impl ::std::fmt::Display for TemplateError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ TemplateError::TemplateNotFound(inner) => write!(f, "Template does not exist for the given identifier: {:?}", inner),
+ TemplateError::RestrictedContent => f.write_str("You do not have permission to modify this template."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }
 
@@ -4170,7 +4218,15 @@ impl ::std::error::Error for UpdatePropertiesError {
 
 impl ::std::fmt::Display for UpdatePropertiesError {
  fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
- write!(f, "{:?}", *self)
+ match self {
+ UpdatePropertiesError::TemplateNotFound(inner) => write!(f, "Template does not exist for the given identifier: {:?}", inner),
+ UpdatePropertiesError::RestrictedContent => f.write_str("You do not have permission to modify this template."),
+ UpdatePropertiesError::UnsupportedFolder => f.write_str("This folder cannot be tagged. Tagging folders is not supported for team-owned templates."),
+ UpdatePropertiesError::PropertyFieldTooLarge => f.write_str("One or more of the supplied property field values is too large."),
+ UpdatePropertiesError::DoesNotFitTemplate => f.write_str("One or more of the supplied property fields does not conform to the template specifications."),
+ UpdatePropertiesError::DuplicatePropertyGroups => f.write_str("There are 2 or more property groups referring to the same templates in the input."),
+ _ => write!(f, "{:?}", *self),
+ }
  }
 }